Table of Contents

Class RestartComputerTask

Namespace
ArcanaDevelopment.adTempus.Client
Assembly
ArcanaDevelopment.adTempus.Client.dll

Task that restarts the host computer

public sealed class RestartComputerTask : Task
Inheritance
object
RestartComputerTask

Remarks

This task initiates a restart or shutdown of the computer where the adTempus service is running (or a remote computer specified by TargetComputer. The user account associated with the job must have permission to restart/shut down the computer

Properties

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.

Delay

Time to delay before shutting down.

public TimeSpan Delay { get; set; }

Property Value

TimeSpan

Remarks

Shutdown is initiated immediately but warning message is displayed for the specified period and shutdown can be aborted during that period.

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.

ShutdownOptions

Options for the operation

public ShutdownOptions ShutdownOptions { get; set; }

Property Value

ShutdownOptions

Remarks

Include Restart to restart the computer. Otherwise the computer is shut down.

Generally you should include ForceAppsClosed to ensure that programs that are hung or waiting for input do not prevent the shutdown/restart.

SupportedResponseEvents

Gets a list of the events that are supported for Responses associated with this task.

public override ReadOnlyCollection<SupportedResponseEvent> SupportedResponseEvents { get; }

Property Value

ReadOnlyCollection<SupportedResponseEvent>

TargetComputer

The name of the computer to shut down/restart. Specify null or empty string to target the adTempus server.

public string TargetComputer { get; set; }

Property Value

string

Remarks

Job Variables are supported.

WarningMessage

Warning message to display to users. Leave empty for default.

public string WarningMessage { get; set; }

Property Value

string

Remarks

Job Variables are supported.

Methods

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.

WriteToConfigurationReport(IADTObjectConfigurationReportWriter)

Writes the object and any contained objects to a configuration report

public override void WriteToConfigurationReport(IADTObjectConfigurationReportWriter reportBuilder)

Parameters

NameTypeDescription
reportBuilder IADTObjectConfigurationReportWriter

The report builder to write the object to.

Inherited Members