Red Hat Satellite
Red Hat Satellite is a system management tool that monitors your Red Hat environments and other Linux distributions. You can bring errata, host, installed package, package, and more data from Red Hat Satellite into Brinqa to gain a unified view of your asset and software inventory, thus strengthening your cybersecurity posture.
This document details the information you must provide for the connector to authenticate with Red Hat Satellite and how to obtain that information from Red Hat. See create a data integration for step-by-step instructions on setting up the integration.
The Red Hat Satellite connector has been tested and verified with Red Hat Satellite v6.11. Compatibility and functionality may differ if you are using other versions of Red Hat Satellite.
Required connection settings
When setting up a data integration, select Red Hat Satellite from the Connector dropdown. If you cannot find the connector in the dropdown, make sure that you have installed it first. You must provide the following information to authenticate Red Hat Satellite with Brinqa:
-
Server URL: Your organization's Red Hat Satellite server URL. The default format is
https://<servername>/. -
Username and Access token: The Red Hat Satellite API username and access token, which must have permissions to log in to the API server and return data.
Generate a Red Hat Satellite access token
Before you create an access token, Red Hat Satellite recommends that you create an API-Only user. This user can only interact with the Red Hat Satellite API, providing the minimum role required to access the API and retrieve data. For additional information, please refer to the Red Hat Satellite documentation.
For the Red Hat Satellite connector to retrieve data from the Red Hat Satellite API, you must provide an access token. To do so, follow these steps:
-
Log in to your organization's Red Hat Satellite server as an administrator.
-
Navigate to Administer > Users and select the API-Only user.
-
Click the Personal Access Tokens tab, and then click Add Personal Access Token.
-
(Optional) Set an expiry date for the token. If not selected, the token does not expire.
-
Click Submit.
Your access token displays. You can not view the token again after this. Copy and save it to a secure location.
If you do not have permissions to create an access token, contact your Red Hat Satellite administrator. For additional information, see Red Hat Satellite documentation.
Additional settings
The Red Hat Satellite connector contains additional options for specific configuration:
-
Page size: The maximum number of records to get per API request. The default setting is 100.
-
Parallel requests: The maximum number of parallel API requests. The default setting is 1.
-
Skip certificate verification: Select this option to allow for untrusted certificates.
Types of data to retrieve
The Red Hat Satellite connector can retrieve the following types of data from the Red Hat Satellite API:
Table 1: Data retrieved from Red Hat Satellite
| Connector Object | Required | Maps to Data Model |
|---|---|---|
| Errata | Yes | Security Advisory |
| Host | Yes | Host |
| Installed Package | No | Installed Package |
| Package | No | Package |
| Product | No | Not mapped |
| Repository | No | Not mapped |
| Subscription | No | Not mapped |
For detailed steps on how to view the data retrieved from Red Hat Satellite in the Brinqa Platform, see How to view your data.
Attribute mappings
Expand the sections below to view the mappings between the source and the Brinqa data model attributes.
Errata
Table 2: Errata attribute mappings
| Source Field Name | Maps to Attribute |
|---|---|
| bugs.bug_id | Local variable |
| bugs.href | Local variable |
| cves.cve_id | cveIds, cveRecordsUid |
| cves.href | Local variable |
| description | description |
| errata_id | Local variable |
| hosts_applicable_count | Local variable |
| hosts_available_count | Local variable |
| id | uid |
| issued | sourceCreatedDate |
| last_sync | Local variable |
| last_sync_words | Local variable |
| name | name |
| organization | Local variable |
| organization_id | Local variable |
| packages | Local variable |
| pulp_id | Local variable |
| repository_count | Local variable |
| severity | severity, severityScore, sourceSeverity |
| solution | recommendation |
| summary | summary |
| sync_plan | Local variable |
| title | Local variable |
| type | type, categories |
| updated | sourceLastModified |
| uuid | Local variable |
Local variable indicates that the field is processed within a specific context, such as a particular workflow or calculation. Unlike other attributes, local variables aren't mapped to the unified data models. They only exist on the source data model.
Host
Table 3: Host attribute mappings
| Source Field Name | Maps to Attribute |
|---|---|
| architecture_name | Local variable |
| bmc_available | Local variable |
| build | Local variable |
| build_status | Local variable |
| build_status_label | Local variable |
| capabilities | Local variable |
| certname | Local variable |
| cockpit_url | Local variable |
| comment | Local variable |
| compute_profile_id | Local variable |
| compute_profile_name | Local variable |
| compute_resource_id | Local variable |
| compute_resource_name | Local variable |
| created_at | sourceCreatedDate |
| disk | Local variable |
| domain_id | Local variable |
| domain_name | Local variable |
| enabled | Local variable |
| errata_status | Local variable |
| errata_status_label | Local variable |
| execution_status | Local variable |
| execution_status_label | Local variable |
| global_status | Local variable |
| global_status_label | status, sourceStatus |
| hostgroup_id | Local variable |
| hostgroup_name | Local variable |
| hostgroup_title | Local variable |
| id | uid |
| image_file | Local variable |
| image_id | Local variable |
| image_name | image |
| infrastructure_facet.foreman_instance | Local variable |
| infrastructure_facet.smart_proxy_id | Local variable |
| installed_at | installDate |
| ip | ipAddresses |
| ip6 | ipAddresses |
| last_compile | Local variable |
| last_report | Local variable |
| location_id | Local variable |
| location_name | location |
| mac | macAddresses |
| managed | managed |
| medium_id | Local variable |
| medium_name | Local variable |
| model_id | Local variable |
| model_name | model |
| name | name, hostnames |
| openscap_proxy | Local variable |
| openscap_proxy_id | Local variable |
| openscap_proxy_name | Local variable |
| operatingsystem_id | Local variable |
| operatingsystem_name | operatingSystem |
| organization_id | Local variable |
| organization_name | Local variable |
| owner_id | Local variable |
| owner_name | owner |
| owner_type | Local variable |
| path | Local variable |
| port | Local variable |
| private_dns_names | privateDnsName |
| provision_method | Local variable |
| ptable_id | Local variable |
| ptable_name | Local variable |
| public_dns_names | publicDnsName |
| puppet_ca_proxy | Local variable |
| puppet_ca_proxy_id | Local variable |
| puppet_ca_proxy_name | Local variable |
| puppet_proxy | Local variable |
| puppet_proxy_id | Local variable |
| puppet_proxy_name | Local variable |
| puppet_status | Local variable |
| purpose_addons_status | Local variable |
| purpose_addons_status_label | Local variable |
| purpose_role_status | Local variable |
| purpose_role_status_label | Local variable |
| purpose_sla_status | Local variable |
| purpose_sla_status_label | Local variable |
| purpose_usage_status | Local variable |
| purpose_usage_status_label | Local variable |
| realm_id | Local variable |
| realm_name | Local variable |
| sp_ip | Local variable |
| sp_mac | Local variable |
| sp_name | Local variable |
| sp_subnet_id | Local variable |
| status | Local variable |
| status_category | Local variable |
| subnet6_id | Local variable |
| subnet6_name | Local variable |
| subnet_id | Local variable |
| subnet_name | Local variable |
| subscription_global_status | Local variable |
| subscription_status | Local variable |
| subscription_status_label | Local variable |
| targets | Local variable |
| type | Local variable |
| uid | uid |
| updated_at | sourceLastModified |
| uptime_seconds | Local variable |
| use_image | Local variable |
| uuid | Local variable |
Local variable indicates that the field is processed within a specific context, such as a particular workflow or calculation. Unlike other attributes, local variables aren't mapped to the unified data models. They only exist on the source data model.
Installed Package
Table 4: Installed Package attribute mappings
| Source Field Name | Maps to Attribute |
|---|---|
| host_id | targets |
| id | uid |
| name | name |
| nvra | Local variable |
| nvrea | Local variable |
Local variable indicates that the field is processed within a specific context, such as a particular workflow or calculation. Unlike other attributes, local variables aren't mapped to the unified data models. They only exist on the source data model.
Package
Table 5: Package attribute mappings
| Source Field Name | Maps to Attribute |
|---|---|
| arch | Local variable |
| checksum | Local variable |
| epoch | Local variable |
| filename | fileName |
| hosts_applicable_count | Local variable |
| hosts_available_count | Local variable |
| id | uid |
| modular | Local variable |
| name | name |
| nvra | Local variable |
| nvrea | Local variable |
| pulp_id | Local variable |
| release | Local variable |
| sourcerpm | Local variable |
| summary | description |
| uuid | Local variable |
| version | currentVersion |
Local variable indicates that the field is processed within a specific context, such as a particular workflow or calculation. Unlike other attributes, local variables aren't mapped to the unified data models. They only exist on the source data model.
Operation options
The Red Hat Satellite connector supports the following operation options:
Table 7: Operation options
| Connector Object | Option | All Possible Values | Description | Example |
|---|---|---|---|---|
| Host | organization_id | Any valid organization ID | Filters hosts by organization. | Key: organization_id Value: 1. Retrieves hosts belonging to organization 1. |
| Host | hostgroup_id | Any valid host group ID | Filters hosts by host group. | Key: hostgroup_id Value: 2. Retrieves hosts belonging to host group 2. |
| Host | thin | true, false | Returns a minimal set of host attributes for faster response. | Key: thin Value: true. Returns lightweight host records. |
| Host | location_id | Any valid location ID | Filters hosts by location. | Key: location_id Value: 3. Retrieves hosts at location 3. |
| Installed Package | status | Any valid status value | Filters installed packages by status. | Key: status Value: upgradable. Retrieves packages that can be upgraded. |
| Package | organization_id | Any valid organization ID | Filters packages by organization. | Key: organization_id Value: 1. Retrieves packages for organization 1. |
| Package | host_id | Any valid host ID | Filters packages by host. | Key: host_id Value: 5. Retrieves packages for host 5. |
| Package | repository_id | Any valid repository ID | Filters packages by repository. | Key: repository_id Value: 10. Retrieves packages from repository 10. |
| Package | environment_id | Any valid environment ID | Filters packages by lifecycle environment. | Key: environment_id Value: 2. Retrieves packages in environment 2. |
APIs
The Red Hat Satellite connector uses the Red Hat Satellite REST API. Specifically, it uses the following endpoints
Table 8: Red Hat Satellite API Endpoints
| Connector Object | API Endpoints |
|---|---|
| Errata | GET /katello/api/v2/errata |
| Host | GET /api/v2/hosts |
| Installed Package | GET /api/hosts/{host_id}/packages |
| Package | GET /katello/api/v2/packages |
| Product | GET /katello/api/v2/products |
| Repository | GET /katello/api/v2/repositories |
| Subscription | GET /katello/api/v2/subscriptions |
Changelog
The Red Hat Satellite connector has undergone the following changes:
Table 9: Red Hat Satellite connector changelog
| Version | Description | Date Published |
|---|---|---|
| 3.0.5 | Improvements - The Satellite models now write attributes through the platform's shared, type-validating attribute helper, so values are validated against the declared schema type at write time instead of being stored with the wrong type. Bug Fixes - Corrected the Satellite Host date attributes ('Install date', 'Source created date', 'Source last modified', 'Last compile') to be stored as proper timestamps (were stored as numbers), matching the connector schema. Migration Required - Host: the date attributes listed above changed from numbers to timestamps. Re-sync the Red Hat connector to repopulate hosts with the corrected type. | June 9th, 2026 |
| 3.0.4 | Improvements - Connector-sourced attribute values now take precedence over non-connector data channels (manual edits, bulk imports, UI input) when the platform consolidates records, so Red Hat data is no longer overridden by lower-priority sources. Bug Fixes - Corrected the data type of several attributes so they match the values returned by the Satellite API: - 'Repository' — 'Library instance id' is now a number (was text), and 'Mirroring policy' is now text (was a number). - 'Subscription' — 'Ram' is now text (was Boolean). Migration Required - 'Repository' and 'Subscription': the attributes listed above changed data type. Re-sync the Red Hat connector to repopulate these records with the corrected types. | June 9th, 2026 |
| 3.0.3 | - Fixed an issue where the connector was not creating a normalized hostname. - Added the PRIVATE_DNS_NAMES and PUBLIC_DNS_NAMES attributes to the Host object. | July 17th, 2024 |
| 3.0.2 | Code cleanup and general maintenance. | July 17th, 2024 |
| 3.0.1 | - Made the Installed Package and Package objects optional in the integration configuration. - Changed the IMAGE_FILE attribute type on the Host object from boolean to string. - Changed the UUID attribute type on the Errata object from integer to string. | June 5th, 2024 |
| 3.0.0 | Initial Integration+ release. | May 6th, 2024 |