Share via

JobServer Class

  • Article

The JobServer object represents the SQL Server Agent subsystem and the msdb database.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.SmoObjectBase
    Microsoft.SqlServer.Management.Smo.SqlSmoObject
      Microsoft.SqlServer.Management.Smo.Agent.JobServer

Namespace:  Microsoft.SqlServer.Management.Smo.Agent
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

Syntax

'Declaration
Public NotInheritable Class JobServer _
    Inherits SqlSmoObject _
    Implements IAlterable, IScriptable
'Usage
Dim instance As JobServer

public sealed class JobServer : SqlSmoObject, 
    IAlterable, IScriptable

public ref class JobServer sealed : public SqlSmoObject, 
    IAlterable, IScriptable

[<SealedAttribute>]
type JobServer =  
    class 
        inherit SqlSmoObject 
        interface IAlterable 
        interface IScriptable 
    end

public final class JobServer extends SqlSmoObject implements IAlterable, IScriptable

The JobServer type exposes the following members.

Properties

  Name Description
Public property AgentDomainGroup Gets the SQL Server Agent domain group.
Public property AgentLogLevel Gets or sets the type of messages that are logged by SQL Server Agent.
Public property AgentMailType Gets or sets the mail type for SQL Server Agent.
Public property AgentShutdownWaitTime Gets or sets the time that SQL Server Agent waits for jobs to complete execution before shutting down.
Public property AlertCategories Represents a collection of AlertCategory objects. Each AlertCategory object represents an alert category defined on SQL Server Agent.
Public property Alerts Represents a collection of Alert objects. Each Alert object represents an alert defined on SQL Server Agent.
Public property AlertSystem The AlertSystem object stores information that applies to all the alerts defined on SQL Server Agent.
Public property DatabaseMailProfile Gets or sets a Database Mail profile.
Public property ErrorLogFile Gets or sets the name and path of the file in which SQL Server Agent records errors.
Public property HostLoginName Gets or sets the login used to log in to SQL Server.
Public property IdleCpuDuration Gets or sets the length of time in seconds that the processor must have to maintain the CPU idle percentage value before the processor is considered idle.
Public property IdleCpuPercentage Gets or sets the CPU idle percentage threshold that the processor is required to achieve before it is considered idle.
Public property IsCpuPollingEnabled Gets or sets the Boolean property value that specifies whether CPU polling is enabled.
Public property JobCategories Represents a collection of JobCategory objects. Each JobCategory object represents a job category defined on Microsoft SQL Server Agent.
Public property Jobs Represents a collection of Job objects. Each Job object represents a job defined on SQL Server Agent.
Public property JobServerType Gets or sets the type of job server with regard to multiserver administration.
Public property LocalHostAlias Gets or sets the local host alias that is used to connect to the local instance of SQL Server.
Public property LoginTimeout Gets or sets the number of seconds after which an attempt to connect times out.
Public property MaximumHistoryRows Gets or sets the maximum number of history rows retained.
Public property MaximumJobHistoryRows Gets or sets the maximum number of history rows retained per job.
Public property MsxAccountCredentialName Gets or sets the Windows account required to connect to the master server using Windows Authentication.
Public property MsxAccountName Gets or sets the login required to connect to the master server using SQL Server Authentication.
Public property MsxServerName Gets or sets the name of the master server participating in multiserver administration.
Public property Name Gets the name of the SQL Server Agent service.
Public property NetSendRecipient Gets or sets the recipient of net send messages.
Public property OperatorCategories Represents a collection of OperatorCategory objects. Each OperatorCategory object represents an operator category defined on SQL Server Agent.
Public property Operators Represents a collection of Operator objects. Each Operator object represents an operator defined on SQL Server Agent.
Public property Parent Gets the Server object that is the parent of the JobServer object.
Public property Properties Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public property ProxyAccounts Represents a collection of ProxyAccount objects. Each ProxyAccount object represents a proxy account defined on Microsoft SQL Server Agent.
Public property ReplaceAlertTokensEnabled Gets or sets the Boolean value that determines whether alert tokens are replaced on the instance of SQL Server Agent.
Public property SaveInSentFolder Gets or sets the Boolean property value that specifies whether the notifications are saved.
Public property ServiceAccount Gets the account under which the SQL Server Agent service runs
Public property ServiceStartMode Gets the mode used to start the SQL Server Agent service.
Public property SharedSchedules Represents a collection of JobSchedule objects. Each JobSchedule object represents a shared schedule defined on SQL Server Agent.
Public property SqlAgentAutoStart Gets or sets the Boolean property value that specifies whether SQL Server Agent is automatically started.
Public property SqlAgentMailProfile Gets or sets a SQL Server Agent mail profile.
Public property SqlAgentRestart Gets or sets the Boolean property value that specifies whether SQL Server Agent is monitored and restarted if it stops.
Public property SqlServerRestart Gets or sets the Boolean property value that specifies whether the SQL Server Service is monitored and restarted if it stops.
Public property State Gets the state of the referenced object. (Inherited from SmoObjectBase.)
Public property SysAdminOnly Gets the Boolean property value that specifies whether CmdExec and ActiveX commands can only be executed by members of the sysadmin fixed server role.
Public property TargetServerGroups Represents a collection of TargetServerGroup objects. Each TargetServerGroup object represents a target server group defined on SQL Server Agent.
Public property TargetServers Represents a collection of TargetServer objects. Each TargetServer object represents a target server defined on SQL Server Agent.
Public property Urn Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
Public property UserData Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)
Public property WriteOemErrorLog Gets or sets the Boolean property value that specifies whether to write the error log to a non-Unicode file or not.

Top

Methods

  Name Description
Public method Alter Updates any JobServer object property changes on an instance of SQL Server. 
Public method ClearHostLoginAccount Clears the host login account and uses integrated security to log in to SQL Server.
Public method ClearMsxAccount Clears the master server login account and uses integrated security to log in to the master server.
Public method CycleErrorLog Closes and renames the current error log, and then creates a new empty error log file.
Public method Discover Discovers a list of type Object. (Inherited from SqlSmoObject.)
Public method DropJobByID Removes the job with the specified ID value.
Public method DropJobsByLogin Removes the job with the specified login name.
Public method DropJobsByServer Removes the job with the specified server.
Public method EnumErrorLogs Enumerates a list of SQL Server Agent error log information.
Public method EnumJobHistory() Enumerates a list of SQL Server Agent job history information.
Public method EnumJobHistory(JobHistoryFilter) Enumerates a list of job history information.
Public method EnumJobs() Enumerates a list of information about the current job.
Public method EnumJobs(JobFilter) Enumerates a list of information about current jobs.
Public method EnumPerformanceCounters() Enumerates a list of SQL Server Agent performance counter information.
Public method EnumPerformanceCounters(String) Enumerates a list of SQL Server Agent performance counter information for the specified object.
Public method EnumPerformanceCounters(String, String) Enumerates a list of SQL Server Agent performance counter information for the specified object and specified counter.
Public method EnumPerformanceCounters(String, String, String) Enumerates a list of SQL Server Agent performance counter information for the specified object, specified counter, and specified instance of SQL Server.
Public method EnumSubSystems Enumerates a list of SQL Server Agent execution subsystems.
Public method Equals (Inherited from Object.)
Protected method FormatSqlVariant Formats an object as SqlVariant type. (Inherited from SqlSmoObject.)
Protected method GetContextDB Gets the context database that is associated with this object. (Inherited from SqlSmoObject.)
Protected method GetDBName Gets the database name that is associated with the object. (Inherited from SqlSmoObject.)
Public method GetHashCode (Inherited from Object.)
Public method GetJobByID Returns a job with the specified ID value.
Protected method GetPropValue Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetPropValueOptional Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetPropValueOptionalAllowNull Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetServerObject Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public method GetType (Inherited from Object.)
Public method Initialize() Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Public method Initialize(Boolean) Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Protected method IsObjectInitialized Verifies whether the object has been initialized. (Inherited from SqlSmoObject.)
Protected method IsObjectInSpace Verifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
Public method MsxDefect() Ends Microsoft SQL Server Agent participation in a multiserver administration group. 
Public method MsxDefect(Boolean) Ends SQL Server Agent participation in a multiserver administration group with the option to force defection.
Public method MsxEnlist Enlists SQL Server Agent as a target server with the specified master server in a multiserver administration.
Public method PurgeJobHistory() Removes all logged records of SQL Server Agent jobs.
Public method PurgeJobHistory(JobHistoryFilter) Removes all logged records of SQL Server Agent jobs as specified by a filter.
Public method ReadErrorLog() Enumerates the error log.
Public method ReadErrorLog(Int32) Enumerates the error log.
Public method ReassignJobsByLogin Changes ownership for any SQL Server Agent job currently owned by a SQL Server login.
Public method Refresh Refreshes the object and retrieves properties when the object is next accessed. (Inherited from SqlSmoObject.)
Public method RemoveJobByID Removes a job with a specified ID value.
Public method RemoveJobsByLogin Removes a job with a specified login.
Public method Script() Generates a Transact-SQL script that can be used to re-create SQL Server Agent.
Public method Script(ScriptingOptions) Generates a Transact-SQL script that can be used to re-create SQL Server Agent as specified by the scripting options.
Public method SetHostLoginAccount Sets the SQL Server authentication account and password used to log in to SQL Server.
Public method SetMsxAccount(String) Sets the name of the credentials used to log in to the master server in multiserver administration.
Public method SetMsxAccount(String, String) Sets the name of the credentials used to log in to the master server in multiserver administration.
Protected method SetParentImpl Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
Public method StartMonitor Starts monitoring the local SQL Server Agent Service by an instance of SQL Server.
Public method StopMonitor Ends monitoring the local SQL Server Agent Service by an instance of SQL Server.
Public method TestMailProfile Tests the validity of an e-mail profile.
Public method TestNetSend Tests the validity of a net send address.
Public method ToString Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
Public method Validate Validates the state of an object. (Inherited from SmoObjectBase.)

Top

Events

  Name Description
Public event PropertyChanged Represents the event that occurs when a property is changed. (Inherited from SqlSmoObject.)
Public event PropertyMetadataChanged Represents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IAlienObject.Discover Discovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetDomainRoot Returns the root of the domain. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetParent Gets the parent of this object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetPropertyType Gets the type of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetPropertyValue Gets the value of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetUrn Gets the Unified Resource Name (URN) of the object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.Resolve Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.SetObjectState Sets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.SetPropertyValue Sets the property value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method ISfcPropertyProvider.GetPropertySet Gets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)

Top

Remarks

When you use the SQL Server Agent objects, you can reference them by using the JobServer object property of the Server object. It is not necessary to call the constructor for the JobServer object because it is automatically created when the constructor is called for the Server object.

Note

If the CompatibilityLevel property for the MSDB database is set to Version70 SMO might throw an exception with a COLLATE error.

To get JobServer object properties, users must be a member of the SQLAgentUserRole database role on the MSDB database, or be a member of the sysadmin fixed server role.

To set JobServer object properties, users must be a member of the sysadmin fixed server role.

To run methods on the JobServer object, users must be a member of the sysadmin fixed server role.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.  

Examples

Scheduling Automatic Administrative Tasks in SQL Server Agent

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.SqlServer.Management.Smo.Agent Namespace

Other Resources

Automated Administration Tasks (SQL Server Agent)

Scheduling Automatic Administrative Tasks in SQL Server Agent

SQL Server Agent Stored Procedures (Transact-SQL)