Class RemoteAgent
- Namespace
- ArcanaDevelopment.adTempus.Client
- Assembly
- ArcanaDevelopment.adTempus.Client.dll
public sealed class RemoteAgent : ADTIndependentObject
- Inheritance
-
objectRemoteAgent
Properties
AgentNumber
public int AgentNumber { get; }
Property Value
- int
AllowedModes
public int AllowedModes { get; set; }
Property Value
- int
CID
The Class ID for the object
[IgnoreDataMember]
public override ClassID CID { get; }
Property Value
Remarks
Obsolete. Use ClassID instead.
CanBeUpdated
Indicates whether the Agent can be updated to a newer version of the adTempus software.
public bool CanBeUpdated { get; }
Property Value
- bool
Certificate
public string Certificate { get; }
Property Value
- string
CertificateIdentity
public string CertificateIdentity { get; set; }
Property Value
- string
ClassKeyName
The key name for the class.
public override string ClassKeyName { get; }
Property Value
- string
Remarks
This name the name used by adTempus to identify the class and is intended for programmatic use only. Use the ClassName for a user-friendly name.
ConfigurationReport
Gets information about the adTempus software configuration on the Agent.
public string ConfigurationReport { get; }
Property Value
- string
ConnectionOptions
Gets or sets options for the connection to the Agent.
public AgentConnectionOptions ConnectionOptions { get; set; }
Property Value
Enabled
public bool Enabled { get; set; }
Property Value
- bool
IsConnected
public bool IsConnected { get; }
Property Value
- bool
IsDependent
[IgnoreDataMember]
public override bool IsDependent { get; }
Property Value
- bool
JobVariables
public JobVariableCollection JobVariables { get; }
Property Value
LastErrorMessage
public string LastErrorMessage { get; }
Property Value
- string
Name
An optional name for the agent, used instead of the ServerAddress to identify it in the user interface.
public string Name { get; set; }
Property Value
- string
NameAndAddress
Returns the Name if one has been specified, in addition to the ServerAddress.
public string NameAndAddress { get; }
Property Value
- string
NameOrAddress
Gets the Name of the Agent, if set, or the Address otherwise.
public string NameOrAddress { get; }
Property Value
- string
Remarks
When returning the address, only the server address, port, and instance name are returned. Any connection properties in the address are stripped out.
Priority
public int Priority { get; set; }
Property Value
- int
ServerAddress
The name or IP address of the agent computer.
public string ServerAddress { get; set; }
Property Value
- string
ServerVersion
Gets the version of the adTempus server software running on the Agent.
public string ServerVersion { get; }
Property Value
- string
StrippedServerAddress
Gets the ServerAddress, with connection properties stripped out.
public string StrippedServerAddress { get; }
Property Value
- string
SupportedModes
public int SupportedModes { get; }
Property Value
- int
UpdateLog
Gets the log from the last software update operation on the Agent.
public string UpdateLog { get; }
Property Value
- string
UpdateStatus
public AgentSoftwareUpdateStatus UpdateStatus { get; }
Property Value
ValidateCertificate
public bool ValidateCertificate { get; set; }
Property Value
- bool
Methods
GetInheritedVariables(bool)
Gets a collection containing the JobVariables inherited by this object, and optionally the variables for the object itself.
public JobVariableCollection GetInheritedVariables(bool includeSelf)
Parameters
| Name | Type | Description |
|---|---|---|
includeSelf |
bool |
Returns
GetObjectDescription()
Gets a description of the object's key settings.
protected override string GetObjectDescription()
Returns
- string
Remarks
This method is called by GetDescription() to get a user-friendly description of the object (such as its key settings) for display to the user. The description should contain enough information to distinguish this object from others of the same class.
- See Also
Resynchronize()
Forces a resynchronization of the Agent by resending all data that the Agent should have.
public void Resynchronize()
Remarks
The caller must have Modify permission for the RemoteAgent.
SendSupportFiles(DiagnosticSubmissionInformation, out string)
Sends the current diagnostic logs for the Agent to Arcana Development for troubleshooting.
public bool SendSupportFiles(DiagnosticSubmissionInformation info, out string message)
Parameters
| Name | Type | Description |
|---|---|---|
info |
DiagnosticSubmissionInformation | |
message |
string |
Returns
- bool
Remarks
Requires Administrator permission
WriteToConfigurationReport(IADTObjectConfigurationReportWriter)
public override void WriteToConfigurationReport(IADTObjectConfigurationReportWriter reportBuilder)
Parameters
| Name | Type | Description |
|---|---|---|
reportBuilder |
IADTObjectConfigurationReportWriter |
Inherited Members
- ADTIndependentObject.Refresh()
- ADTIndependentObject.Revert()
- ADTIndependentObject.Save()
- ADTIndependentObject.SaveWithAuditOrSnapshot(ChangeLogParameters)
- ADTIndependentObject.Save(out MessageCollection)
- ADTIndependentObject.SaveWithAuditOrSnapshot(ChangeLogParameters, out MessageCollection)
- ADTIndependentObject.Delete()
- ADTIndependentObject.DeleteWithAuditOrSnapshot(ChangeLogParameters)
- ADTIndependentObject.GetSecurityDescriptor()
- ADTIndependentObject.ReplaceObjectReferences(string[], bool, int, IEnumerable<OID>, ADTObject, bool, ChangeLogParameters)
- ADTIndependentObject.GetObjectReferences(string[], bool, int)
- ADTObject.LastModified
- ADTObject.CreationTimestamp
- ADTObject.FromMaster
- ADTObject.OID
- ADTObject.ClassID
- ADTObject.BindingDescription
- ADTObject.ToString()
- ADTObject.ParentObject
- ADTObject.CanPerform(SecurityPermission)
- ADTObject.Duplicate()
- ADTObject.DataContext
- ADTObject.AccessMask
- ADTObject.Validate(MessageCollection)
- ADTObject.SupportedSecurityActions
- ADTObject.SupportedSecurityInheritanceOptions
- ADTObject.GetTopLevelOwner()
- ADTObject.GetConfigurationReport()
- ADTObject.GetConfigurationReport(bool)
- ADTObject.ExtendedDescription
- ADTObject.IsReadOnly
- ObjectBase.IsDirty
- ObjectBase.IsNew
- ObjectBase.IsStub
- ObjectBase.ClassName
- ObjectBase.GetDescription()
- ObjectBase.BeginEdit()
- ObjectBase.BeginEdit(UndoLevelAction)
- ObjectBase.CommitEdit(Guid)
- ObjectBase.CommitEdit()
- ObjectBase.UndoEdit()
- ObjectBase.UndoEdit(Guid)