Class AdminSettings

Namespace

Kepware.Api.Model.Admin

Assembly

Kepware.Api.dll

Represents the administrative settings of the Kepware server.

[Endpoint("/config/v1/admin", null)]
public class AdminSettings : DefaultEntity, IEquatable<BaseEntity>, IHaveOwner

Inheritance

object

BaseEntity

DefaultEntity

AdminSettings

Implements

IEquatable<BaseEntity>

IHaveOwner

Inherited Members

DefaultEntity.Owner

BaseEntity.Hash

BaseEntity.ProjectId

BaseEntity.Description

BaseEntity.TypeName

BaseEntity.DynamicProperties

BaseEntity.Equals(BaseEntity)

BaseEntity.GetDynamicProperty<T>(string)

BaseEntity.SetDynamicProperty<T>(string, T)

BaseEntity.TryGetGetDynamicProperty<T>(string, out T)

BaseEntity.CalculateHash()

BaseEntity.AppendHashSources(CustomHashGenerator.HashSourceBuilder)

BaseEntity.ConditionalNonSerialized()

BaseEntity.Cleanup(IKepwareDefaultValueProvider, bool, CancellationToken)

BaseEntity.GetUpdateDiff(DefaultEntity)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

AdminSettings()

Properties

CommDiagnosticsLogFilePath

Directory path where Communication Diagnostics log files are stored.

CommDiagnosticsMaxRecords

Maximum number of Communication Diagnostics log records before removal of oldest records.

CommDiagnosticsMaxSingleFileSizeKb

Maximum size in KB of a single Communication Diagnostics log file.

CommDiagnosticsMinDaysToPreserve

Minimum number of days before Communication Diagnostics log files are deleted.

CommDiagnosticsPersistence

The persistence mode for Communication Diagnostics log data.

EventLogConnectionPort

The TCP/IP port used for event log communication.

EventLogLogFilePath

Directory path where event log files are stored.

EventLogLogToConsole

Set to true to print event log messages to the console window/stdout.

EventLogMaxRecords

Maximum number of records retained in the event log before deletion of oldest records.

EventLogMaxSingleFileSizeKb

Maximum size in KB of a single event log file.

EventLogMinDaysToPreserve

Minimum number of days before event log files are deleted.

EventLogPersistence

Persistence mode for the event log (Memory, Single File, or Extended Datastore).

LicenseServer

Configuration settings for the license server. Only available when the Kepware server supports licensing via license server like the TKE.

OpcDiagnosticsLogFilePath

Directory path where OPC Diagnostics log files are stored.

OpcDiagnosticsMaxRecords

Maximum number of OPC Diagnostics log records before removal of oldest records.

OpcDiagnosticsMaxSingleFileSizeKb

Maximum size in KB of a single OPC Diagnostics log file.

OpcDiagnosticsMinDaysToPreserve

Minimum number of days before OPC Diagnostics log files are deleted.

OpcDiagnosticsPersistence

The persistence mode for OPC Diagnostics log data.