TheServiceHostInfo Properties
The TheServiceHostInfo type exposes the following members.
Properties
Name | Description | |
---|---|---|
AccessControlAllowHeaders |
CORS Settings that allows only certain headers. Default *
|
|
AccessControlAllowMethods |
CORS Settings that allows only certain methods. Default *
|
|
AccessControlAllowOrigin |
CORS Settings that allows access from other domains
|
|
ActivationKeysToAdd | ||
AllEnginesAreStarting |
Set when the C-DEngine starts all Plugin Services
|
|
AllowAdhocScopes |
Allows to create Browser based AdHoc scopes...allowed only on CloudNodes
|
|
AllowAnonymousAccess |
retired
|
|
AllowAutoUpdate |
If true, remote nodes can force an automatic update of this node
|
|
AllowDistributedResourceFetch |
If true, each scoped node in a mesh can provide resources for any other node without the need for a browser to have a valid scoped session.
This is a (relative uncritical) security downgrade: normally a browser session has to be authenticated against a scope first. But since resources are considered "static" or "outside NMI Scope" they would need their own user management anyway.
|
|
AllowEnvironmentVars |
If true, the C-DEngine HSI Parameters can be set via Environment variables
|
|
AllowEnvironmentVarsToOverrideConfig |
If true, the C-DEngine environment variables will take precedence over settings specified via command line or app.config
///
|
|
AllowForeignScopeIDRouting |
If set, the current node will route telegrams through that do have different ScopeIDs
from the current node
|
|
AllowLocalHost |
If Set to true, the C-DEngine will accept "http://localhost" as an additional inbound URL
|
|
AllowMessagesInConnect |
If set to true, the CDEngine is will process device messages in the initial CDE_CONNECT message. Note that, while secure, this will bypass the additional security measures provided by the CDEngine sessions like protection against replay attacks.
|
|
AllowRemoteAdministration |
If set to true, many administrative operations can be performed from any FR in the mesh, not just from the FR that is to be managed ("FirstNode").
|
|
AllowRemoteThingCreation |
If set to true, plug-ins on trusted nodes can create things on this nodes via TSM messages
|
|
AllowSetScopeWithSetAdmin | ||
AllowUnscopedMesh |
if set to true, unscoped nodes can create their own mesh
|
|
AllSystemsReady | ||
ApplicationName |
Application Name - has to match all nodes in mesh for UPnP auto-connect
|
|
ApplicationRoles | Obsolete.
A list of known plugins to this node. Any plugin found in the BaseDirectory will be added to this list automatically
|
|
ApplicationTitle |
Application title for the Portal screen - this can be any arbitrary string
|
|
AreAllEnginesStarted |
Is set to true when all Engines (Plugin-Service) have been started
|
|
AsyncEngineStartup |
If True, all plugins/services/engines will be registered, Init and CreateUX asynchronously. InitEngineAssets will be called synchronously before
|
|
AuditNMIChanges |
If true, all changes initiated from the NMI will be logged
|
|
AzureAnalytics |
Set to enable Windows Azure cloud analytics if you host the C-DEngine in Windows Azure
|
|
BaseBackgroundColor |
Sets the base Background color for the "Clean" screen.
|
|
BaseDirectory |
Base directory of the current C-DEngine instance
|
|
BaseForegroundColor |
Sets the base Foreground color for the Clean screen.
|
|
CacheMaxAge |
MaxAge of HTTP Cache in Seconds
|
|
cdeAVA |
Availability of this record
The higher this number the higher the availability of this record
The Storage Service might store the data in multiple location to ensure maximum availability
(Inherited from TheDataBase.) |
|
cdeCTIM |
Timestamp of this class. Will be set to DateTimeOffset.Now on creation of the Class
(Inherited from TheDataBase.) |
|
cdeEXP |
Expiration in Seconds of the class
If a derived class is stored in a StorageMirror and cdeEXP is set to>0, the StorageMirror will automatically delete this record after the time has passed
(Inherited from TheDataBase.) |
|
cdeHostingType |
The cdeHostType of the node running the current instance of the C-DEngine
|
|
cdeMID |
Unique Key for the class derived from TheDataBase. this will be used in the StorageService as the Unique Index in the SQL Tables
(Inherited from TheDataBase.) |
|
cdeN |
Guid of Hosting Node - new in 4.108: Moved from MetaDataBase to here
(Inherited from TheDataBase.) |
|
cdeNodeType |
The cdeNodeType defines the communication architecture used for this node.
|
|
cdePlatform |
Return the platform the current instance if running on
|
|
cdePRI |
Priority of this record.
A lower number means a higher priority.
Data with higher priority will be retrieved faster than those with lower prio
(Inherited from TheDataBase.) |
|
CDEPUBSUBrecv | ||
CDEPUBSUBrejects | ||
CDEPUBSUBsent | ||
CDEPUBSUBSrejects | ||
ClientCertificateThumb |
Thumbprint of a client certificate to use for mesh communication
|
|
ClientCertificateUsage |
If set to 0 or does not exist, a client certificate is not used and not required (default mode of previous CDE versions)
If Set to 1, client can present a client certificate. If no scopes are in the cert, scopes will be used as before (Mix operation between new and old security mode)
If Set to 2, client must present a valid client certificate. If no scopes are in the cert, scopes will be used as before (was previous "RequireClientCertificate=true") (previous default mode but with Client Certificate turned on)
If set to 3, all clients (including NMI browsers) need to present a client certificate (new enforced Client Certificate Mode only - older CDE Nodes will not able to connect)
If the client certificate contains one or more SAN URLs of the scheme "com.c-labs.cdescope://" the client will only participate in scopes with that scopeID. The first cdescope is used as the ScopeID if no scope is presented in the message or connection
In IIS, settings 2 and 3 require the "Client Certificates" setting in "SSL Settings" to be set as "Accept" or "Require" for NMI access
|
|
CloudBlobURL |
Cloud Blob Address
|
|
CloudServiceRoute |
RETIRED in V4: LocalServiceRoutes and CloudServiceRoutes will be mapped to ServiceRoute - no differnce between Cloud and Local route in V4
Entry will be removed in V5
|
|
CodeSignThumb |
Contains the current code signing Thumbprint
|
|
ConnToken | ||
ContentTemplate | ||
Copyrights |
Copyright statement for relay
|
|
Coufs |
Create User on first start will only be executed if IsNewDevice=true
|
|
CSSDlg | ||
CSSMain | ||
CurrentVersion |
Current version of the C-DEngine or your application
Use this format:
FullVersion.MinorVersion
|
|
CustomUA |
The UserAgent used by the REST commands that can be overwritten for special Firewall policies.
|
|
DebTrgtSrv | ||
DebugLevel |
Debug Level of the Application
The higher the level - the more verbose the output
|
|
DefAccountPage | ||
DefaultLCID | ||
DefHomePage | ||
DefLoginPage | ||
DefSignupPage | ||
Description | ||
DisableCache |
If true, the C-DEngine will not cache any resources.
|
|
DisableChunking |
If true, the SmartQueue will chunk any message. ATTENTION: If a device cannot handle
large messages, because it ran out of memory or the message is larger than the buffer
a device can handle, the large telegram will be lost!
|
|
DisableConsole |
If set to true, no Log output will go the the console. Logger plugins are not affected
|
|
DisableFastTSMs |
Every TSM(...) constructor will set the SID (expensive envryption)
if not set (default) the two WriteToLog constructors will NOT set the SID during construction
|
|
DisableNMI | ||
DisableNMIMessages | ||
DisablePLSCompression |
Disables PLS compression (does not compress PLS to PLB if PLB is empty and PLS.Length>512)
|
|
DisablePriorityInversion |
If true, the SmartQueue will not change any set priority
|
|
DisableRSAToBrowser |
If set to True, the Browser will not be able to RSA Encrypt, ScopeID, UID or Password
In the future we might use our own security algorithm here since the RSA Implementation of .NET varies on all platforms!
|
|
DisableTls12 |
Disables the TLS 1.2 Requirement
|
|
DisableUPnPAutoConnect |
If set to true, the UPnP discovery system will not automatically connect to other nodes if a compatible node was found.
|
|
DisableWebSockets |
If set to true, the WebSockets communication stack will be disabled even if a MyWSStationPort was defined
|
|
DISCOMX |
Sets the UPnP MX record for M-SEARCH broadcasts to a specific value. Should be between 0 and 5. Default is 3
|
|
DISCOScanRate |
Sets the Scan Rate for Discovery. If set to zero, No periodic scanning will take place. Default is 60 seconds
|
|
DISCOSubnet |
Limits the SSDP/UPnP M-SEARCH scans to the defined subnet. can be up to three of the 4 IP segments. i.e.: 10 or 10.1 or 192.168.1
|
|
DontFallbackToDevice |
if true and the internal webserver cannot be created due to a conflict with other installed servers, the node will terminate.
if false (Default) the node will disable the internal webserver and just run as a "Device" changing the cdeHostingType to "Device"
|
|
DontRelayNMI |
Prevents NMI telegrams from being routed across the Cloud - cloud connected browsers will get telegrams
|
|
DontVerifyIntegrity |
if true, the C-DEngine is running in "Unsafe" mode: plug-ins can be tampered with
|
|
DontVerifyTrust |
if true, the C-DEngine is running in "Unsafe" mode and custom plugins can be installed
|
|
EnableAutoLogin |
If set, Mobile device will not autologin the last user even if there is a record of it
|
|
EnableBingScan |
If set to true during startup, this node will try to find Cloud nodes using Bing Search.
|
|
EnableCosting |
Is true if Costing per telegram is enabled on this node
|
|
EnableFastSecurity |
If true, trades off slightly faster communication for a
less secure connection (fewer changes of security tokens).
|
|
EnableHistorianDataLog |
If True, the thing history system will log various diagnostics logs
|
|
EnableIntegration |
If set to true, the CDEngine is running embedded/integrated in another web solution
|
|
EnableIsolation |
If true, the relay does support isolation
|
|
EnableTaskKPIs |
If true the Tasks will measure KPIs
|
|
EnforceFifoQueue |
If set to true, packages/telegrams within a QDX will always be send in FIFO mode. If False, QDX priority smaller 3 will be sent as FILO
|
|
EntryDate | ||
EventTimeout |
Timeout for Thing Events (in milliseconds).
|
|
FailOnAdminCheck |
If true, the host will exit if the HttpLIstener (that requires Admin Rights) could not be started and "DontFallbackToDevice" is true. If DontFallbackToDevice is true, the WebServer of the CDE will be disable and the node runs as a "Device"
|
|
FallbackToSimulation |
retired
|
|
favicon_ico | ||
FireGlobalTimerSync |
If True, the QueuedSenderHealth Timer will fire synchronously. Default is async
|
|
ForceWebPlatform |
For debugging purposes, this flag can be set to always force output on browsers to a specific platform
|
|
HasInternetAccess |
If set to true, the node has access to the public internet.
|
|
HeartbeatDelay |
Amount of Seconds Delay to check on Heartbeat
|
|
IgnoreAdminCheck | Obsolete.
If this is not set, the node will not start if it was not launched with Administrator Previledges
|
|
IgnoredEngines |
A list of plugins that should not be started even if they were found in the BaseDirectory
|
|
IgnoreServerCertificateChainErrors |
Allows SSL certificates for which the trust chain could not be validated (including expired certificates)
|
|
IgnoreServerCertificateErrors |
Ignores any SSL certificate validation errors (default behavior before 4.208)
|
|
IgnoreServerCertificateNameMismatch |
Allows SSL connections to servers for which the provided certificate does not match the host name.
|
|
IgnoreServerCertificateNotAvailable |
Allows SSL connections to servers that do not provide an SSL certificate.
|
|
IsBackingUp |
True if the system is currently backing up the cache folder
|
|
IsCloudDisabled |
Set this to true to disable the cloud temporarily
|
|
IsCloudNMIBlocked |
NEW:3.2 If set to true, the User Information is no longer replicated via the cloud and users cannot login to the NMI via the cloud
To set from a plugin use "TheCommCore.SetCloudNMIBlock(true|false, GUID pUser); only Admins on the "FirstNode" can change this setting
|
|
IsCloudService |
If set to true, the current node is a Cloud Service.
|
|
IsConnectedToCloud |
Is true if the current node is currently connected to the cloud
|
|
IsIsolated |
If True, this instance is only hosting one plugin isloated. It connects to a master Node
|
|
IsMemoryOptimized |
If true, the node tries to be as memory optimized as possible. Performance might be slightly decreased and logging and other storage based options might be unavailable
|
|
ISMExtension |
Defines the file extension for updates
|
|
ISMMainExecutable |
Contains the name of the running Application hosting the C-DEngine
|
|
ISMScanForUpdatesOnUSB |
If set to true, the C-DEngine will listen to USB ports for USB sticks containing Updates and new Plugins
|
|
ISMScanOnStartup |
If set to true, the C-DEngine will scan for new updates during the startup
|
|
ISMUpdateDirectory |
Specifies a specific directory to look for updates.
Default is: BaseDirectory/ClientBin/Updates
|
|
ISMUpdateVersion |
Will contain the version of an update found in the directory or a stick
|
|
IsNewDevice |
Set to true if the Node was run for the first time
|
|
IsoEngine |
the current ISO Engine of the node. Only this engine/plugin is loaded
|
|
IsoEngines |
A list of plugins that will be hosted isolated in their own process
|
|
IsoEnginesToLoad |
A list of confirmed plugins that will be hosted isolated in their own process
|
|
IsOutOfBrowser |
Silverlight Only: Tells the plugins if TheBaseApplication is hosted our of browser (SLLauncher)
|
|
IsOutputCompressed |
For debugging purposes, indicate whether message parameters (PLS) can be compressed.
|
|
IsSSLEnforced |
If this is set to true, the C-DEngine will not accept inbound connection on HTTP but requires HTTPS
|
|
IsUserManagerInStorage |
If set to true and the StorageService is alive, the User Information will be stored/retreived via TheStorageService
|
|
IsUsingUPnP | Obsolete.
If set to False, the UPnP discovery system was disabled
|
|
IsUsingUserMapper |
If set to true, the built-in User Manager will be used instead of plain Easy-ScopeIDs
|
|
IsViewer |
Set to true if the current C-DEngine Application Host (TheBaseApplication) is a Viewer (only ONE user logged in at any give time)
|
|
IsWebSocket8Active |
Set to true if the C-DEngine is using Windows8/Server 2012 WebSockets (http.sys)
|
|
IsWSHBDisabled |
Enabled this to disable the WebSocket Heartbeat. If the Hearbeat is off and no traffic is flowing between a browser and the first-node, the browser will time out when the session expires
|
|
LastUpdate | ||
LocalServiceRoute |
RETIRED in V4: LocalServiceRoutes and CloudServiceRoutes will be mapped to ServiceRoute - no differnce between Cloud and Local route in V4
Entry will be removed in V5
|
|
LoginReferrers | ||
MainConfigScreen |
The NMI Screen with the main Relay Configuration Page
|
|
MaxBatchedTelegrams |
New in V3.200: Maximum amount of telegrams batched together
|
|
MaximumHops |
If this value is greater than zero and a telegram comes in with a higher node count in the telegram, it will be rejected.
|
|
MinPluginVersion |
Minimum Version of plugin required to run
|
|
MonoActive |
True if the C-Dengine is running on Mono
|
|
MonoDetected | Obsolete.
True of the C-DEngine is running inside the Mono-Runtime
|
|
MonoRTActive |
Same as MonoActive
|
|
MonoRTDetected |
Set if Mono Runtime Detection was run...dont use to detect MONO Runtime - please use MonoRTActive of MonoActive
|
|
MyAltStationURLs |
A list of alternative URLs that this node might have and allows connection to.
Any URL not specified in MyStationURL and MyAltStationURLs will not allow inbound communication
|
|
MyAppPresenter |
should contain "companyXYZ presents..."
Will be printed on Default about us pages
|
|
MyAppServices |
RETIRED in V4: will be replaced in V5. Use MyLiveServices instead
|
|
MyDeviceInfo |
The DeviceInfo contains all the information about the device the current instance is running on:
MyDeviceInfo = Hardware Device - Where is the CDE running on?
cdePlatform = OS Version - Are we on Mono, 64Bit or 32Bit?
cdeHostingType = Application Type - Where is the CDE running in?
cdeNodeType = Communication Type - How can this node communicate with other nodes?
|
|
MyDeviceMoniker |
Retired
|
|
MyLiveServices | ||
MyStationIP |
If known, this holds the IP of the current instance of the C-DEngine
|
|
MyStationMoniker |
Retired
|
|
MyStationName |
Friendly name of the current Node/Station. Uses the MyStationURL if not set
|
|
MyStationPort |
The inbound port of the current instance for HTTP connections. If set to zero, this node will not accept incoming connections
|
|
MyStationURL |
The main URL of this Node
|
|
MyStationWSPort |
In inbound port for WebSockets connections. If set to zero, this node will not accept inbound WebSockets connections
|
|
navbutton_color | ||
NodeBlacklist |
NodeIDs in this list will be prevented from connecting to this node.
|
|
NodeName |
Allows to give the node a friendly name.
|
|
OptScrRes16by9 | ||
OptScrRes4by3 | ||
OSInfo |
OS the node is running on
|
|
P3PPolicy_XML | ||
ParallelPosts | ||
PermittedUnscopedNodesIDs |
A list of node IDs that are allowed to participate in the mesh communication although they do not have a proper ScopeID.
This is useful for unscoped small devices such as sensors that need to send information to the mesh but do not have the proper OS to participate in the encrypted security of C-DEngine nodes
|
|
PortalPage |
Defines the default portal page (see AddSmartPage). By default this should be "NMIPORTAL".
|
|
PresetDeviceID |
Set this Guid if you want your device to have a predefined DeviceID. If no DeviceID is
specified, the C-DEngine will create a random DeviceID and stores it at the very first startup.
Any subsequent system starts use this same DeviceID.
If UseRandomDeviceID is set, the C-DEngine will not store this ID.
|
|
PreShutDownDelay |
if set to >0 the shutdown will be delayed by these ms. Plugins can set this value if necessary
|
|
PrioInversionTime |
Defines the time in seconds that triggers a Queue Priority Inversion. If a message is longer in the queue as the specified value in this parameter, the message will be sent next. If this value is zero, the QueuedSender does not perform Priority Inversion
|
|
ProtocolVersion |
Current CDE-T Version
|
|
Redirect404 | ||
RejectIncomingSETP |
If true, incoming SETP will not be processed - only use for High throughput Nodes in meshes where the NMI is not needed
|
|
RelayEngines |
A list of virtual plugins not running on the current node but are allowed to route telegrams through this node.
|
|
RequiredClientCertRootThumbprints |
List of Thumbprints of allowed client certificates
|
|
RequiresConfiguration |
If this is set to true, the C-DEngine is not completely configured, yet. For example no ScopeID
has been issued for the current node. This is not critical for the run-time of the C-DEngine and
is user mainly by Application Configuration Plugins such as the Factory-Relay.
|
|
ResourcePath |
Path for JavaScript resources if Engine is embedded in other cloud solution
|
|
Revision | ||
Robots_txt | ||
RootDir |
The Root Path on the current node.
|
|
SealID | ||
SecurityLevel |
If set to higher than 3 every telegram will include a new RSA Key. On Devices with slow or no TPMs creation of an RSA Key can take multiple seconds
If set to lower than 3 the C-DEngine will accept untrusted SSL Certificates. This might be important for debugging against a self-signed certificate.
Default is 3
|
|
SenderQueueSize |
Maximum size of the Sender Queue
|
|
ServiceRoute |
Url and Path to a designated next node with the same ApplicationID. This can point to multiple nodes by separating the URLs with a semicolon (;)
|
|
SessionTimeout | ||
ShowMarkupInLog |
if true, All Log Entries with DeviceIDs/NodeIDs and ScopeHashes will add Markup for better debugging in cdeSTatus.aspx
|
|
ShutdownOnLicenseFailure |
If set, the cdeEngine will shutdown when it encounters no activated license
|
|
SimulatedEngines |
retired
|
|
SiteName | ||
SKUID |
Main SKU of the current node
|
|
SrvSec | ||
StartISM |
If set to true, the ISM - Intelligent Service Management will be activated.
This has to be set before call ing StartBaseApplication()
|
|
StartISMDisco |
If set to true, the UPnP Discovery System will be enabled.
|
|
StartupEngines |
retired
|
|
StationRoles | Obsolete.
A list of Plugins that will be running as services on the current node
|
|
StatusColors |
Sets Custom Status Colors for a Relay - Separate the values with ;
0=Idle
1=Active / ok
2=Warning
3=Error
4=Setup/RampUp
5=Design / Engineering / Configuration
6=Shutdown
7=Unknown/unreachable
|
|
StatusLevel |
The current StatusLevel of the Relay - aggregates all Engine Status Levels to the highest level
0=Idle
1=Active / ok
2=Warning
3=Error
4=Setup/RampUp
5=Design / Engineering / Configuration
6=Shutdown
7=Unknown/Unreachable
|
|
StoreLoggedMessages |
If set to True, the system will store Message in a Distributed Storage Mirror
|
|
ThingRegistryStoreInterval |
The time interval the ThingRegistry will be saved to Disk
|
|
TileColor | ||
TileImage | ||
Title | ||
TLDCGs | ||
TO |
This structure allows to set all important timeouts of the C-DEngine
|
|
TokenLifeTime |
Live time for User Refresh Tokens
|
|
TopLogo | ||
TopLogoURL | ||
TrackAccess |
Enables the Access Tracker for User Activities
|
|
TrgtSrv | ||
UPnPDeviceType |
This defines the "StandardDeviceType" for UPnP. Default is "InternetGatewayDevice"
|
|
UPnPIcon | ||
UseEasyScope16 |
use new 16 digits EasyScopeID
|
|
UseGELFLoggingFormat |
Sets the GELF Loggin Format as the standard format for Console Output
|
|
UseHBTimerPerSender |
if true, each QSender will get its own Heartbeat timer
|
|
UseRandomDeviceID |
If set to true, the C-DEngine will create a new random DeviceID every time it starts up.
Benefit: Great for debugging and ad-hoc devices
Be aware: no data is made persitant! The ThingRegistry and other databasees will be cleared with every restart
|
|
UseTcpListenerInsteadOfHttpListener |
If set to true, a TCP Listener will be used without first attempting to create an HttpListener.
|
|
VendorData |
Custom Vendor Data that will be included in the UPnP metadata
You will get this ID assigned from from C-Labs once you have licensed the C-DEngine
|
|
VendorID |
Guid of the Application Owner
This guid will allow easy access to vendor information in the Plugin-Store
|
|
VendorName |
Human Readable name of the Vendor creating this Application
|
|
VendorUrl |
A URl pointing at the Vendors WebSite
|
|
VerifyTrustPath |
If true, the C-DEngine will verify the Trust path of the code-signing certificate. Internet connection is REQUIRED
|
|
Version | ||
WsJsThrottle |
Allows to throttle WebSocket Messages to JavaScript clients. Messages will not be sent faster than this number
Default is zero (No Throttling)
|