Red Hat Satellite
System Management- Overview
- Setup
- Data & mappings
- Operations & API
- Changelog
The Satellite connector integrates with Red Hat Satellite (Foreman/Katello). It syncs managed host inventory along with the content metadata that describes the software running on those hosts: errata (advisories), products, repositories, subscriptions, content packages, and the packages installed on each host. Hosts and packages are mapped to Brinqa asset models; errata and installed packages support vulnerability and software-inventory analysis.
Data is retrieved from the Satellite/Foreman REST API. Results are paginated, and the connector iterates organizations and hosts as needed for host-scoped content (such as installed packages).
Data retrieved from Satellite
| Connector Object | Required | Maps to Data Model |
|---|---|---|
| Host | Yes | Host |
| Errata | Yes | Errata |
| Subscription | Yes | Subscription |
| Product | Yes | Product |
| Repository | Yes | Repository |
| Package | Yes | Package |
| InstalledPackage | Yes | Installed Package |
Model relationships
For detailed steps on how to view the data retrieved from Satellite in the Brinqa Platform, see How to view your data.
Connection settings
When setting up a data integration, select Satellite from the Connector dropdown and provide the following:
| Setting | Required | Default | Description |
|---|---|---|---|
| Server URL | Yes | — | Satellite server URL |
| Username | Yes | — | Satellite API username |
| Access token | Yes | — | Satellite API access token |
| Page size | No | 100 | Maximum number of records to get per API request |
| Parallel requests | No | min(1, available processors) | Maximum number of parallel API requests |
| SSL / TLS | No | false | Skip certificate verification |
Authentication
Satellite uses HTTP Basic authentication. The connector encodes {username}:{accessToken} with Base64 and sends it in the Authorization header on every request. The access token is a Satellite user password or personal access token.
Endpoint
| Method | URL |
|---|---|
| GET | {url}/api/status (connection test) |
| GET | {url}/api/v2/hosts and the Katello content endpoints (model data) |
Request Headers
| Header | Value |
|---|---|
Authorization | Basic base64({username}:{accessToken}) |
Content-Type | application/json |
Request Body
Model reads are GET requests with query parameters (pagination, organization, etc.); there is no request body.
Sample Response
The connection-test endpoint returns the Satellite version and status:
{
"satellite_version": "6.11.0",
"result": "ok",
"status": "ok"
}
Response Fields
| Field | Description |
|---|---|
result / status | Health indicator returned by /api/status. |
results | Array of records returned by list endpoints (hosts, errata, products, etc.). |
total / subtotal / page / per_page | Pagination metadata on list responses. |
How the credential is used
The username and access token are stored as configuration properties (the access token is confidential). On every request the connector builds Authorization: Basic <base64(username:accessToken)> and applies it as a request header.
Sync Behavior
Each sync is a full sync. Every run enumerates all records; the connector accepts a sync token but does not apply it as an incremental filter.
How to obtain Satellite credentials
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.
Note: 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.
Attribute mappings
Expand the sections below to view the mappings between the source and the Brinqa data model attributes:
Host
| Source Field Name | SDM Attribute |
|---|---|
| ASSET_CATEGORY_HOST | Categories |
Host.created_at | Source Created Date |
Host.global_status_label | Status / Source Status |
Host.id | UID |
Host.image_name | Image |
Host.installed_at | Install Date |
Host.ip, Host.ip6 | Ip Addresses |
Host.location_name | Location |
Host.mac | MAC Addresses |
Host.managed | Managed |
Host.model_name | Model |
Host.name | Name / Hostnames |
Host.operatingsystem_name | Operating System |
Host.owner_name | Owner |
Host.updated_at | Source Last Modified |
Errata
| Source Field Name | SDM Attribute |
|---|---|
Errata.cves[].cve_id | CVE IDs / CVE Records |
Errata.description | Description |
Errata.id | UID |
Errata.issued | Source Created Date |
Errata.name | Name |
Errata.severity | Severity / Severity Score / Source Severity |
Errata.solution | Recommendation |
Errata.summary | Summary |
Errata.type | Type / Categories |
Errata.updated | Source Last Modified |
Subscription
| Source Field Name | SDM Attribute |
|---|---|
Subscription.end_date | Termination Date |
Subscription.id | UID |
Subscription.name | Name |
Subscription.product_name | Targets |
Subscription.start_date | Source Created Date |
Subscription.type | Type |
Product
| Source Field Name | SDM Attribute |
|---|---|
Product.description | Description |
Product.id | UID |
Product.name | Name |
Repository
| Source Field Name | SDM Attribute |
|---|---|
Repository.content_type | Type |
Repository.description | Description |
Repository.full_path | Path |
Repository.id | UID |
Repository.name | Name |
Repository.os_versions | Affected Version |
Repository.product.id | Targets |
Repository.url | URL |
Package
| Source Field Name | SDM Attribute |
|---|---|
| ASSET_CATEGORY_PACKAGE | Categories |
Package.filename | File Name |
Package.id | UID |
Package.name | Name |
Package.summary | Description |
Package.version | Current Version |
InstalledPackage
| Source Field Name | SDM Attribute |
|---|---|
host_id (path variable) | Targets |
InstalledPackage.id | UID |
InstalledPackage.name | Name |
Operations & API
Expand each connector object to see its operation options, delta-sync behavior, and the API it uses. See connector operation options for how to apply operation options (keys and values are case-sensitive).
Host
Operation options
This object does not support any operation options.
Delta sync
Not supported. The connector performs a full sync of Host on every run and applies no incremental date filter.
API
- Type: REST endpoint · Endpoint:
GET /api/v2/hosts
Errata
Operation options
This object does not support any operation options.
Delta sync
Not supported. The connector performs a full sync of Errata on every run and applies no incremental date filter.
API
- Type: REST endpoint · Endpoint:
GET /katello/api/v2/errata
Subscription
Operation options
This object does not support any operation options.
Delta sync
Not supported. The connector performs a full sync of Subscription on every run and applies no incremental date filter.
API
- Type: REST endpoint · Endpoint:
GET /katello/api/v2/subscriptions
Product
Operation options
This object does not support any operation options.
Delta sync
Not supported. The connector performs a full sync of Product on every run and applies no incremental date filter.
API
- Type: REST endpoint · Endpoint:
GET /katello/api/v2/products
Repository
Operation options
This object does not support any operation options.
Delta sync
Not supported. The connector performs a full sync of Repository on every run and applies no incremental date filter.
API
- Type: REST endpoint · Endpoint:
GET /katello/api/v2/repositories
Package
Operation options
This object does not support any operation options.
Delta sync
Not supported. The connector performs a full sync of Package on every run and applies no incremental date filter.
API
- Type: REST endpoint · Endpoint:
GET /katello/api/v2/packages
InstalledPackage
Operation options
This object does not support any operation options.
Delta sync
Not supported. The connector performs a full sync of InstalledPackage on every run and applies no incremental date filter.
API
- Type: REST endpoint · Endpoint:
GET /api/hosts/{host_id}/packages
Changelog
The Satellite connector has undergone the following changes:
| Version | Description | Migration Steps |
|---|---|---|
| 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. | • Host: the date attributes listed above changed from numbers to timestamps. Re-sync the Red Hat connector to repopulate hosts with the corrected type. |
| 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). | • Repository and Subscription: the attributes listed above changed data type. Re-sync the Red Hat connector to repopulate these records with the corrected types. |
| 3.0.3 | No changes in this release. | N/A |
| 3.0.2 | New Features - Satellite hosts now capture DNS names alongside IP addresses, populating separate public and private DNS name attributes based on whether the hostname resolves to a public or private domain. Improvements - Host names are now normalized before being stored, and the original unmodified value is preserved in a new "Raw Hostname" attribute so the source-reported name is always available. | N/A |
| 3.0.1 | Bug Fixes - Corrected the data type of two Satellite attributes so they match the values returned by the Satellite API: - Errata — "uuid" is now text (was a number). - Host — "Image file" is now text (was Boolean). | • Errata and Host: the attributes listed above changed data type. Re-sync the Red Hat connector to repopulate these records with the corrected types. |
| 3.0.0 | Overview The Red Hat Satellite connector integrates with Red Hat Satellite to synchronize host inventory along with the packages, errata, repositories, products, and subscriptions associated with those hosts. Category: System Management Models | N/A |