Export (0) Print
Expand All

JobServer Class

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

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)

public sealed class JobServer : SqlSmoObject, 
	IAlterable, IScriptable

The JobServer type exposes the following members.

  NameDescription
Public propertyAgentDomainGroupGets the SQL Server Agent domain group.
Public propertyAgentLogLevelGets or sets the type of messages that are logged by SQL Server Agent.
Public propertyAgentMailTypeGets or sets the mail type for SQL Server Agent.
Public propertyAgentShutdownWaitTimeGets or sets the time that SQL Server Agent waits for jobs to complete execution before shutting down.
Public propertyAlertCategoriesRepresents a collection of AlertCategory objects. Each AlertCategory object represents an alert category defined on SQL Server Agent.
Public propertyAlertsRepresents a collection of Alert objects. Each Alert object represents an alert defined on SQL Server Agent.
Public propertyAlertSystemThe AlertSystem object stores information that applies to all the alerts defined on SQL Server Agent.
Public propertyDatabaseMailProfileGets or sets a Database Mail profile.
Public propertyErrorLogFileGets or sets the name and path of the file in which SQL Server Agent records errors.
Public propertyHostLoginNameGets or sets the login used to log in to SQL Server.
Public propertyIdleCpuDurationGets 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 propertyIdleCpuPercentageGets or sets the CPU idle percentage threshold that the processor is required to achieve before it is considered idle.
Public propertyIsCpuPollingEnabledGets or sets the Boolean property value that specifies whether CPU polling is enabled.
Public propertyJobCategoriesRepresents a collection of JobCategory objects. Each JobCategory object represents a job category defined on Microsoft SQL Server Agent.
Public propertyJobsRepresents a collection of Job objects. Each Job object represents a job defined on SQL Server Agent.
Public propertyJobServerTypeGets or sets the type of job server with regard to multiserver administration.
Public propertyLocalHostAliasGets or sets the local host alias that is used to connect to the local instance of SQL Server.
Public propertyLoginTimeoutGets or sets the number of seconds after which an attempt to connect times out.
Public propertyMaximumHistoryRowsGets or sets the maximum number of history rows retained.
Public propertyMaximumJobHistoryRowsGets or sets the maximum number of history rows retained per job.
Public propertyMsxAccountCredentialNameGets or sets the Windows account required to connect to the master server using Windows Authentication.
Public propertyMsxAccountNameGets or sets the login required to connect to the master server using SQL Server Authentication.
Public propertyMsxServerNameGets or sets the name of the master server participating in multiserver administration.
Public propertyNameGets the name of the SQL Server Agent service.
Public propertyNetSendRecipientGets or sets the recipient of net send messages.
Public propertyOperatorCategoriesRepresents a collection of OperatorCategory objects. Each OperatorCategory object represents an operator category defined on SQL Server Agent.
Public propertyOperatorsRepresents a collection of Operator objects. Each Operator object represents an operator defined on SQL Server Agent.
Public propertyParentGets the Server object that is the parent of the JobServer object.
Public propertyPropertiesGets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public propertyProxyAccountsRepresents a collection of ProxyAccount objects. Each ProxyAccount object represents a proxy account defined on Microsoft SQL Server Agent.
Public propertyReplaceAlertTokensEnabledGets or sets the Boolean value that determines whether alert tokens are replaced on the instance of SQL Server Agent.
Public propertySaveInSentFolderGets or sets the Boolean property value that specifies whether the notifications are saved.
Public propertyServiceAccountGets the account under which the SQL Server Agent service runs
Public propertyServiceStartModeGets the mode used to start the SQL Server Agent service.
Public propertySharedSchedulesRepresents a collection of JobSchedule objects. Each JobSchedule object represents a shared schedule defined on SQL Server Agent.
Public propertySqlAgentAutoStartGets or sets the Boolean property value that specifies whether SQL Server Agent is automatically started.
Public propertySqlAgentMailProfileGets or sets a SQL Server Agent mail profile.
Public propertySqlAgentRestartGets or sets the Boolean property value that specifies whether SQL Server Agent is monitored and restarted if it stops.
Public propertySqlServerRestartGets or sets the Boolean property value that specifies whether the SQL Server Service is monitored and restarted if it stops.
Public propertyStateGets the state of the referenced object. (Inherited from SmoObjectBase.)
Public propertySysAdminOnlyGets the Boolean property value that specifies whether CmdExec and ActiveX commands can only be executed by members of the sysadmin fixed server role.
Public propertyTargetServerGroupsRepresents a collection of TargetServerGroup objects. Each TargetServerGroup object represents a target server group defined on SQL Server Agent.
Public propertyTargetServersRepresents a collection of TargetServer objects. Each TargetServer object represents a target server defined on SQL Server Agent.
Public propertyUrnGets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
Public propertyUserDataGets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)
Public propertyWriteOemErrorLogGets or sets the Boolean property value that specifies whether to write the error log to a non-Unicode file or not.
Top

  NameDescription
Public methodAlterUpdates any JobServer object property changes on an instance of SQL Server. 
Public methodClearHostLoginAccountClears the host login account and uses integrated security to log in to SQL Server.
Public methodClearMsxAccountClears the master server login account and uses integrated security to log in to the master server.
Public methodCycleErrorLogCloses and renames the current error log, and then creates a new empty error log file.
Public methodDiscoverDiscovers a list of type Object. (Inherited from SqlSmoObject.)
Public methodDropJobByIDRemoves the job with the specified ID value.
Public methodDropJobsByLoginRemoves the job with the specified login name.
Public methodDropJobsByServerRemoves the job with the specified server.
Public methodEnumErrorLogsEnumerates a list of SQL Server Agent error log information.
Public methodEnumJobHistory()Enumerates a list of SQL Server Agent job history information.
Public methodEnumJobHistory(JobHistoryFilter)Enumerates a list of job history information.
Public methodEnumJobs()Enumerates a list of information about the current job.
Public methodEnumJobs(JobFilter)Enumerates a list of information about current jobs.
Public methodEnumPerformanceCounters()Enumerates a list of SQL Server Agent performance counter information.
Public methodEnumPerformanceCounters(String)Enumerates a list of SQL Server Agent performance counter information for the specified object.
Public methodEnumPerformanceCounters(String, String)Enumerates a list of SQL Server Agent performance counter information for the specified object and specified counter.
Public methodEnumPerformanceCounters(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 methodEnumSubSystemsEnumerates a list of SQL Server Agent execution subsystems.
Public methodEquals (Inherited from Object.)
Protected methodFormatSqlVariantFormats an object as SqlVariant type. (Inherited from SqlSmoObject.)
Protected methodGetContextDBGets the context database that is associated with this object. (Inherited from SqlSmoObject.)
Protected methodGetDBNameGets the database name that is associated with the object. (Inherited from SqlSmoObject.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetJobByIDReturns a job with the specified ID value.
Protected methodGetPropValueGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetPropValueOptionalGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetPropValueOptionalAllowNullGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetServerObjectGets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public methodGetType (Inherited from Object.)
Public methodInitialize()Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Public methodInitialize(Boolean)Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Protected methodIsObjectInitializedVerifies whether the object has been initialized. (Inherited from SqlSmoObject.)
Protected methodIsObjectInSpaceVerifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
Public methodMsxDefect()Ends Microsoft SQL Server Agent participation in a multiserver administration group. 
Public methodMsxDefect(Boolean)Ends SQL Server Agent participation in a multiserver administration group with the option to force defection.
Public methodMsxEnlistEnlists SQL Server Agent as a target server with the specified master server in a multiserver administration.
Public methodPurgeJobHistory()Removes all logged records of SQL Server Agent jobs.
Public methodPurgeJobHistory(JobHistoryFilter)Removes all logged records of SQL Server Agent jobs as specified by a filter.
Public methodReadErrorLog()Enumerates the error log.
Public methodReadErrorLog(Int32)Enumerates the error log.
Public methodReassignJobsByLoginChanges ownership for any SQL Server Agent job currently owned by a SQL Server login.
Public methodRefreshRefreshes the object and retrieves properties when the object is next accessed. (Inherited from SqlSmoObject.)
Public methodRemoveJobByIDRemoves a job with a specified ID value.
Public methodRemoveJobsByLoginRemoves a job with a specified login.
Public methodScript()Generates a Transact-SQL script that can be used to re-create SQL Server Agent.
Public methodScript(ScriptingOptions)Generates a Transact-SQL script that can be used to re-create SQL Server Agent as specified by the scripting options.
Public methodSetHostLoginAccountSets the SQL Server authentication account and password used to log in to SQL Server.
Public methodSetMsxAccount(String)Sets the name of the credentials used to log in to the master server in multiserver administration.
Public methodSetMsxAccount(String, String)Sets the name of the credentials used to log in to the master server in multiserver administration.
Protected methodSetParentImplSets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
Public methodStartMonitorStarts monitoring the local SQL Server Agent Service by an instance of SQL Server.
Public methodStopMonitorEnds monitoring the local SQL Server Agent Service by an instance of SQL Server.
Public methodTestMailProfileTests the validity of an e-mail profile.
Public methodTestNetSendTests the validity of a net send address.
Public methodToStringReturns a String that represents the referenced object. (Inherited from SqlSmoObject.)
Public methodValidateValidates the state of an object. (Inherited from SmoObjectBase.)
Top

  NameDescription
Public eventPropertyChangedRepresents the event that occurs when a property is changed. (Inherited from SqlSmoObject.)
Public eventPropertyMetadataChangedRepresents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.)
Top

  NameDescription
Explicit interface implemetationPrivate methodIAlienObject.DiscoverDiscovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetDomainRootReturns the root of the domain. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetParentGets 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 methodIAlienObject.GetPropertyTypeGets the type of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetPropertyValueGets the value of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetUrnGets 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 methodIAlienObject.ResolveGets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.SetObjectStateSets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.SetPropertyValueSets the property value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodISfcPropertyProvider.GetPropertySetGets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)
Top

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.

NoteNote

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.  

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

Community Additions

ADD
Show:
© 2014 Microsoft