Endpoint
The endpoint object defines the API connection path (URL, username, and password) to the managed endpoint. As the manager operates, the endpoint object is updated with the state and configuration of the endpoint. The endpoint object also controls if the manager should update configuration by versionsets.
The endpoint object has the standard object fields.
| Field | Description |
|---|---|
Id |
The name of the endpoint. This should be the HaId from the endpoint in question. It will be automatically set by join. |
HaId |
The HA ID of the endpoint. It is set automatically. |
Arch |
The architecture of the endpoint. It is set automatically. |
Os |
The OS of the endpoint. It is set automatically. |
ConnectionStatus |
A string of the current state of the endpoint (connecting or updating). |
Params |
The endpoint object uses the Params field to include connection parameters. |
DRPVersion |
Defines the currently installed DRP Version. |
DRPUXVersion |
Defines the currently installed DRP UX Version. |
Components |
A list of elements installed (these are content packages and plugin providers). |
Plugins |
A list of current plugin configurations. The list is pluginp objects from the endpoint. |
Prefs |
A map of string pref values that contain all the preferences from the endpoint. |
Global |
The contents of the global profile on the system. |
Apply |
A boolean field that if true causes the version sets to be applied to the endpoint. |
VersionSet |
Deprecated. A single versionset object name. |
VersionSets |
A list of versionset object names to apply to the system. |
Actions |
This contains a list of actions that need to be applied to the system. This can be used to preview changes. |
The Params field includes several params used for endpoint connection details.
| Field | Description | Param Name |
|---|---|---|
| The param that defines the URL for the endpoint. | manager/url |
|
| The param that defines the username for the endpoint. | manager/username |
|
| The param that defines the password for the endpoint. | manager/password |
The Components field inclues a list of Elements installed (these are content packages and plugin providers).
| Item | Description | Example Values |
|---|---|---|
Name |
Name of the element. | burnin, bios |
Type |
Type of the element. | CP, PP |
Version |
Version of the element (short form) | tip, stable, v4.3.2 |
ActualVersion |
Actual Version of the element (long form) |