Class RemoteAgent

Namespace

ArcanaDevelopment.adTempus.Client

Assembly

ArcanaDevelopment.adTempus.Client.dll

Represents a Remote Agent where jobs can be run.

public sealed class RemoteAgent : ADTIndependentObject, ISupportJobVariables

Inheritance

object

ObjectBase

ADTObject

ADTIndependentObject

RemoteAgent

Implements

ISupportJobVariables

Remarks

Jobs are not assigned to Remote Agents directly; they are assigned to JobQueues, which then target RemoteAgents.

Properties

AgentNumber

The agent number assigned to this agent.

public int AgentNumber { get; }

Property Value

int

Remarks

The Controller assigns an agent number sequentially to each agent added. The agent number is used as a prefix to the InstanceID for job instances that trigger on the agent (to avoid duplication of instance numbers issued on the Controller).

AllowedModes

The queue types supported by this agent

public int AllowedModes { get; set; }

Property Value

int

CanBeUpdated

Indicates whether the Agent can be updated to a newer version of the adTempus software.

public bool CanBeUpdated { get; }

Property Value

bool

See Also

ServerVersion

Certificate

The serialized security certificate from the agent

public string Certificate { get; }

Property Value

string

CertificateIdentity

Gets or sets the identity to use when validating the connection to the remote server

public string CertificateIdentity { get; set; }

Property Value

string

ClassID

The Class ID for the object

[IgnoreDataMember]
public override ClassID ClassID { get; }

Property Value

ClassID

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

AgentConnectionOptions

Enabled

Determines whether this agent is enabled

public bool Enabled { get; set; }

Property Value

bool

Remarks

If the Agent is disabled, no jobs will be sent to it.

IsConnected

Indicates whether this agent is currently connected

public bool IsConnected { get; }

Property Value

bool

See Also

LastErrorMessage

IsDependent

Indicates whether the object is a dependent of (owned by) another object

[IgnoreDataMember]
public override bool IsDependent { get; }

Property Value

bool

Remarks

An independent object (IsDependent is false) is an object that can exist on its own without being part of another object. For example, Jobs, Job Groups, etc.

A dependent object (IsDependent is true) is a part of another object. For example, a JobStep cannot exist independently of a Job, so the JobStep is dependent.

Dependent objects cannot be directly fetched from the server: they are only fetched as part of the object they belong to. They also cannot be saved or deleted independently: they are automatically saved or deleted when the owning object is saved or deleted.

JobVariables

Collection of Job Variables for this agent

public JobVariableCollection JobVariables { get; }

Property Value

JobVariableCollection

Remarks

Variables defined here override the server-level variables from the Controller (they become the server-level variables for the Agent).

LastErrorMessage

If the agent is not currently connected, contains an error message indicating what the problem is.

public string LastErrorMessage { get; }

Property Value

string

See Also

IsConnected

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.

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

See Also

CanBeUpdated

StrippedServerAddress

Gets the ServerAddress, with connection properties stripped out.

public string StrippedServerAddress { get; }

Property Value

string

SupportedModes

Indicates the EngineMode of the adTempus service on the remote agent

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

Gets the status of the software update process if an update from the Controller has been initiated

public AgentSoftwareUpdateStatus UpdateStatus { get; }

Property Value

AgentSoftwareUpdateStatus

ValidateCertificate

Determines whether the Controller validates the agent's security certificate when connecting

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	If true the returned collection contains both inherited variables and variables defined at this level. If false the results only include inherited variables.

Returns

JobVariableCollection

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.

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.

WriteToConfigurationReport(IADTObjectConfigurationReportWriter)

Writes the object and any contained objects to a configuration report

public override void WriteToConfigurationReport(IADTObjectConfigurationReportWriter reportBuilder)

Parameters

Name	Type	Description
reportBuilder	IADTObjectConfigurationReportWriter	The report builder to write the object to.

Inherited Members

• ADTIndependentObject.Refresh()
• ADTIndependentObject.Revert()
• ADTIndependentObject.Save()
• ADTIndependentObject.Save(out MessageCollection)
• ADTIndependentObject.SaveWithAuditOrSnapshot(ChangeLogParameters)
• 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)
• ADTIndependentObject.GetObjectReferences(string[], bool, int, OID[])
• ADTObject.LastModified
• ADTObject.CreationTimestamp
• ADTObject.FromController
• ADTObject.CustomProperties
• ADTObject.Description
• ADTObject.DescriptionTextType
• ADTObject.OID
• 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.IsReadOnly
• ObjectBase.IsDirty
• ObjectBase.IsNew
• ObjectBase.IsStub
• ObjectBase.ClassName
• ObjectBase.GetDescriptionWithClassName()
• ObjectBase.GetDescription()
• ObjectBase.BeginEdit()
• ObjectBase.BeginEdit(UndoLevelAction)
• ObjectBase.CommitEdit(Guid)
• ObjectBase.CommitEdit()
• ObjectBase.UndoEdit()
• ObjectBase.UndoEdit(Guid)