Endpoint Object

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	Definition
ActionErrorCount	ActionErrorCount is the number of failed actions in the action list If the whole list is tried and no progress is made the apply will stop.
Actions	Actions is the list of actions to take to make the endpoint match the version sets on in the endpoint object.
Actions/Action	Action defines what is to be done to this element. These can be Set for Pref, Global. These can be AddOrUpdate and Delete for the reset of the elements. This field is ignored for the DRP and DRPUX element. It is assumed AddOrUpdate.
Actions/ActualVersion	ActualVersion is the actual catalog version referenced by this element. This is used for translating tip and stable into a real version. This is the source of the file element. This can be a relative or absolute path or an URL.
Actions/Name	Name defines the name of the element. Normally, this is the name of the the DRP, DRPUX, filename, plugin, ContentPackage, or PluginProvider Name. For Global and Pref, these are the name of the global parameter or preference.
Actions/ReplaceWritable	ReplaceWritable tells whether or not content packs should replace writable content Defaults to false.
Actions/Type	Type defines the type of element This can be: DRP, DRPUX, File, Global, Plugin, Pref, PluginProvider, ContentPackage
Actions/Value	Value defines what should be set or applied. This field is used for the plugin, pref, global, and file elements. Plugin, Pref, and Global elements use this as the value for the element. File elements use this field to determine if it should be exploded.
Actions/Version	Version defines the short or reference version of the element. e.g. tip, stable, v4.3.6
Apply	Apply toggles whether the manager should update the endpoint.
Arch	Arch is the arch of the endpoint - Golang arch format.
Components	Components is the list of ContentPackages and PluginProviders installed and their versions
Components/ActualVersion	ActualVersion is the actual catalog version referenced by this element. This is used for translating tip and stable into a real version. This is the source of the file element. This can be a relative or absolute path or an URL.
Components/Name	Name defines the name of the element. Normally, this is the name of the the DRP, DRPUX, filename, plugin, ContentPackage, or PluginProvider Name. For Global and Pref, these are the name of the global parameter or preference.
Components/ReplaceWritable	ReplaceWritable tells whether or not content packs should replace writable content Defaults to false.
Components/Type	Type defines the type of element This can be: DRP, DRPUX, File, Global, Plugin, Pref, PluginProvider, ContentPackage
Components/Version	Version defines the short or reference version of the element. e.g. tip, stable, v4.3.6
ConnectionStatus	ConnectionStatus reflects the manager's state of interaction with the endpoint
DRPUXVersion	DRPUXVersion is the version of the ux installed on the endpoint.
DRPVersion	DRPVersion is the version of the drp endpoint running.
Description	Description is a string for providing a simple description
Documentation	Documentation is a string for providing additional in depth information.
Global	Global is the Parameters of the global profile.
HaId	HaId is the HaId of the endpoint
Id	Id is the name of the DRP endpoint this should match the HA pair's ID or the DRP ID of a single node.
Meta	Meta contains the meta data of the object. The type of this field is a key / value map/dictionary. The key type is string. The value type is also string. The general content of the field is undefined and can be an arbritary store. There are some common known keys: color - The color the UX uses when displaying icon - The icon the UX uses when displaying * title - The UX uses this for additional display information. Often the source of the object. Specific Object types use additional meta data fields. These are described at: https://docs.rackn.io/stable/redirect/?ref=rs_object_metadata
Os	Os is the os of the endpoint - Golang os format.
Params	Params holds the values of parameters on the object. The field is a key / value store of the parameters. The key is the name of a parameter. The key is of type string. The value is the value of the parameter. The type of the value is defined by the parameter object. If the key doesn't reference a parameter, the type of the object can be anything. The system will enforce the named parameter's value's type. Go calls the "anything" parameters as "interface {}". Hence, the type of this field is a map[string]interface{}.
Plugins	Plugins is the list of Plugins configured on the endpoint.
Plugins/Description	Description is a string for providing a simple description
Plugins/Documentation	Documentation is a string for providing additional in depth information.
Plugins/Meta	Meta contains the meta data of the object. The type of this field is a key / value map/dictionary. The key type is string. The value type is also string. The general content of the field is undefined and can be an arbritary store. There are some common known keys: color - The color the UX uses when displaying icon - The icon the UX uses when displaying * title - The UX uses this for additional display information. Often the source of the object. Specific Object types use additional meta data fields. These are described at: https://docs.rackn.io/stable/redirect/?ref=rs_object_metadata
Plugins/Name	The name of the plugin instance. THis must be unique across all plugins. required: true
Plugins/Params	Params holds the values of parameters on the object. The field is a key / value store of the parameters. The key is the name of a parameter. The key is of type string. The value is the value of the parameter. The type of the value is defined by the parameter object. If the key doesn't reference a parameter, the type of the object can be anything. The system will enforce the named parameter's value's type. Go calls the "anything" parameters as "interface {}". Hence, the type of this field is a map[string]interface{}.
Plugins/PluginErrors	Error unrelated to the object validity, but the execution of the plugin.
Plugins/Provider	The plugin provider for this plugin required: true
Prefs	Prefs is the value of all the prefs on the endpoint.
VersionSet	VersionSet - Deprecated - was a single version set. This should be specified within the VersionSets list
VersionSets	VersionSets replaces VersionSet - code processes both This is the list of version sets to apply. These are merged with the first in the list having priority over later elements in the list.

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)