JobServer Class

JobServer Class

 

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

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


public sealed class JobServer : SqlSmoObject, IAlterable, IScriptable

NameDescription
System_CAPS_pubpropertyAgentDomainGroup

Gets the SQL Server Agent domain group.

System_CAPS_pubpropertyAgentLogLevel

Gets or sets the type of messages that are logged by SQL Server Agent.

System_CAPS_pubpropertyAgentMailType

Gets or sets the mail type for SQL Server Agent.

System_CAPS_pubpropertyAgentShutdownWaitTime

Gets or sets the time that SQL Server Agent waits for jobs to complete execution before shutting down.

System_CAPS_pubpropertyAlertCategories

Represents a collection of AlertCategory objects. Each AlertCategory object represents an alert category defined on SQL Server Agent.

System_CAPS_pubpropertyAlerts

Represents a collection of Alert objects. Each Alert object represents an alert defined on SQL Server Agent.

System_CAPS_pubpropertyAlertSystem

The AlertSystem object stores information that applies to all the alerts defined on SQL Server Agent.

System_CAPS_pubpropertyDatabaseMailProfile

Gets or sets a Database Mail profile.

System_CAPS_pubpropertyErrorLogFile

Gets or sets the name and path of the file in which SQL Server Agent records errors.

System_CAPS_pubpropertyHostLoginName

Gets or sets the login used to log in to SQL Server.

System_CAPS_pubpropertyIdleCpuDuration

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.

System_CAPS_pubpropertyIdleCpuPercentage

Gets or sets the CPU idle percentage threshold that the processor is required to achieve before it is considered idle.

System_CAPS_pubpropertyIsCpuPollingEnabled

Gets or sets the Boolean property value that specifies whether CPU polling is enabled.

System_CAPS_pubpropertyJobCategories

Represents a collection of JobCategory objects. Each JobCategory object represents a job category defined on Microsoft SQL Server Agent.

System_CAPS_pubpropertyJobs

Represents a collection of Job objects. Each Job object represents a job defined on SQL Server Agent.

System_CAPS_pubpropertyJobServerType

Gets or sets the type of job server with regard to multiserver administration.

System_CAPS_pubpropertyLocalHostAlias

Gets or sets the local host alias that is used to connect to the local instance of SQL Server.

System_CAPS_pubpropertyLoginTimeout

Gets or sets the number of seconds after which an attempt to connect times out.

System_CAPS_pubpropertyMaximumHistoryRows

Gets or sets the maximum number of history rows retained.

System_CAPS_pubpropertyMaximumJobHistoryRows

Gets or sets the maximum number of history rows retained per job.

System_CAPS_pubpropertyMsxAccountCredentialName

Gets or sets the Windows account required to connect to the master server using Windows Authentication.

System_CAPS_pubpropertyMsxAccountName

Gets or sets the login required to connect to the master server using SQL Server Authentication.

System_CAPS_pubpropertyMsxServerName

Gets or sets the name of the master server participating in multiserver administration.

System_CAPS_pubpropertyName

Gets the name of the SQL Server Agent service.

System_CAPS_pubpropertyNetSendRecipient

Gets or sets the recipient of net send messages.

System_CAPS_pubpropertyOperatorCategories

Represents a collection of OperatorCategory objects. Each OperatorCategory object represents an operator category defined on SQL Server Agent.

System_CAPS_pubpropertyOperators

Represents a collection of Operator objects. Each Operator object represents an operator defined on SQL Server Agent.

System_CAPS_pubpropertyParent

Gets the Server object that is the parent of the JobServer object.

System_CAPS_pubpropertyProperties

Gets a collection of Property objects that represent the object properties.(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyProxyAccounts

Represents a collection of ProxyAccount objects. Each ProxyAccount object represents a proxy account defined on Microsoft SQL Server Agent.

System_CAPS_pubpropertyReplaceAlertTokensEnabled

Gets or sets the T:Systen.Boolean value that determines whether alert tokens are replaced on the instance of SQL Server Agent.

System_CAPS_pubpropertySaveInSentFolder

Gets or sets the Boolean property value that specifies whether the notifications are saved.

System_CAPS_pubpropertyServiceAccount

Gets the account under which the SQL Server Agent service runs

System_CAPS_pubpropertyServiceStartMode

Gets the mode used to start the SQL Server Agent service.

System_CAPS_pubpropertySharedSchedules

Represents a collection of JobSchedule objects. Each JobSchedule object represents a shared schedule defined on SQL Server Agent.

System_CAPS_pubpropertySqlAgentAutoStart

Gets or sets the Boolean property value that specifies whether SQL Server Agent is automatically started.

System_CAPS_pubpropertySqlAgentMailProfile

Gets or sets a SQL Server Agent mail profile.

System_CAPS_pubpropertySqlAgentRestart

Gets or sets the Boolean property value that specifies whether SQL Server Agent is monitored and restarted if it stops.

System_CAPS_pubpropertySqlServerRestart

Gets or sets the Boolean property value that specifies whether the SQL Server Service is monitored and restarted if it stops.

System_CAPS_pubpropertyState

Gets the state of the referenced object.(Inherited from SmoObjectBase.)

System_CAPS_pubpropertySysAdminOnly

Gets the Boolean property value that specifies whether CmdExec and ActiveX commands can only be executed by members of the sysadmin fixed server role.

System_CAPS_pubpropertyTargetServerGroups

Represents a collection of TargetServerGroup objects. Each TargetServerGroup object represents a target server group defined on SQL Server Agent.

System_CAPS_pubpropertyTargetServers

Represents a collection of TargetServer objects. Each TargetServer object represents a target server defined on SQL Server Agent.

System_CAPS_pubpropertyUrn

Gets the Uniform Resource Name (URN) address value that uniquely identifies the object.(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyUserData

Gets or sets user-defined data associated with the referenced object.(Inherited from SmoObjectBase.)

System_CAPS_pubpropertyWriteOemErrorLog

Gets or sets the Boolean property value that specifies whether to write the error log to a non-Unicode file or not.

NameDescription
System_CAPS_pubmethodAlter()

Updates any JobServer object property changes on an instance of SQL Server. 

System_CAPS_pubmethodClearHostLoginAccount()

Clears the host login account and uses integrated security to log in to SQL Server.

System_CAPS_pubmethodClearMsxAccount()

Clears the master server login account and uses integrated security to log in to the master server.

System_CAPS_pubmethodCycleErrorLog()

Closes and renames the current error log, and then creates a new empty error log file.

System_CAPS_pubmethodDiscover()

Discovers a list of type Object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodDropJobByID(Guid)

Removes the job with the specified ID value.

System_CAPS_pubmethodDropJobsByLogin(String)

Removes the job with the specified login name.

System_CAPS_pubmethodDropJobsByServer(String)

Removes the job with the specified server.

System_CAPS_pubmethodEnumErrorLogs()

Enumerates a list of SQL Server Agent error log information.

System_CAPS_pubmethodEnumJobHistory()

Enumerates a list of SQL Server Agent job history information.

System_CAPS_pubmethodEnumJobHistory(JobHistoryFilter)

Enumerates a list of job history information.

System_CAPS_pubmethodEnumJobs()

Enumerates a list of information about the current job.

System_CAPS_pubmethodEnumJobs(JobFilter)

Enumerates a list of information about current jobs.

System_CAPS_pubmethodEnumPerformanceCounters()

Enumerates a list of SQL Server Agent performance counter information.

System_CAPS_pubmethodEnumPerformanceCounters(String)

Enumerates a list of SQL Server Agent performance counter information for the specified object.

System_CAPS_pubmethodEnumPerformanceCounters(String, String)

Enumerates a list of SQL Server Agent performance counter information for the specified object and specified counter.

System_CAPS_pubmethodEnumPerformanceCounters(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.

System_CAPS_pubmethodEnumSubSystems()

Enumerates a list of SQL Server Agent execution subsystems.

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFormatSqlVariant(Object)

Formats an object as T: Microsoft.Data.Schema.Sql.DataGenerator.SqlVariant type.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetContextDB()

Gets the context database that is associated with this object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetDBName()

Gets the database name that is associated with the object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetJobByID(Guid)

Returns a job with the specified ID value.

System_CAPS_protmethodGetPropValue(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetPropValueOptional(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetPropValueOptionalAllowNull(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetServerObject()

Gets the server of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodInitialize()

Initializes the object and forces the properties be loaded.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodInitialize(Boolean)

Initializes the object and forces the properties be loaded.(Inherited from SqlSmoObject.)

System_CAPS_protmethodIsObjectInitialized()

Verifies whether the object has been initialized.(Inherited from SqlSmoObject.)

System_CAPS_protmethodIsObjectInSpace()

Verifies whether the object is isolated or connected to the instance of SQL Server.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodMsxDefect()

Ends Microsoft SQL Server Agent participation in a multiserver administration group. 

System_CAPS_pubmethodMsxDefect(Boolean)

Ends SQL Server Agent participation in a multiserver administration group with the option to force defection.

System_CAPS_pubmethodMsxEnlist(String, String)

Enlists SQL Server Agent as a target server with the specified master server in a multiserver administration.

System_CAPS_pubmethodPurgeJobHistory()

Removes all logged records of SQL Server Agent jobs.

System_CAPS_pubmethodPurgeJobHistory(JobHistoryFilter)

Removes all logged records of SQL Server Agent jobs as specified by a filter.

System_CAPS_pubmethodReadErrorLog()

Enumerates the error log.

System_CAPS_pubmethodReadErrorLog(Int32)

Enumerates the error log.

System_CAPS_pubmethodReassignJobsByLogin(String, String)

Changes ownership for any SQL Server Agent job currently owned by a SQL Server login.

System_CAPS_pubmethodRefresh()

Refreshes the object and retrieves properties when the object is next accessed.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodRemoveJobByID(Guid)

Removes a job with a specified ID value.

System_CAPS_pubmethodRemoveJobsByLogin(String)

Removes a job with a specified login.

System_CAPS_pubmethodScript()

Generates a Transact-SQL script that can be used to re-create SQL Server Agent.

System_CAPS_pubmethodScript(ScriptingOptions)

Generates a Transact-SQL script that can be used to re-create SQL Server Agent as specified by the scripting options.

System_CAPS_pubmethodSetHostLoginAccount(String, String)

Sets the SQL Server authentication account and password used to log in to SQL Server.

System_CAPS_pubmethodSetMsxAccount(String)

Sets the name of the credentials used to log in to the master server in multiserver administration.

System_CAPS_pubmethodSetMsxAccount(String, String)

Sets the name of the credentials used to log in to the master server in multiserver administration.

System_CAPS_protmethodSetParentImpl(SqlSmoObject)

Sets the parent of the SqlSmoObject to the newParent parameter.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodStartMonitor(String, Int32)

Starts monitoring the local SQL Server Agent Service by an instance of SQL Server.

System_CAPS_pubmethodStopMonitor()

Ends monitoring the local SQL Server Agent Service by an instance of SQL Server.

System_CAPS_pubmethodTestMailProfile(String)

Tests the validity of an e-mail profile.

System_CAPS_pubmethodTestNetSend()

Tests the validity of a net send address.

System_CAPS_pubmethodToString()

Returns a String that represents the referenced object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodValidate(String, Object[])

Validates the state of an object.(Inherited from SmoObjectBase.)

NameDescription
System_CAPS_pubeventPropertyChanged

Represents the event that occurs when a property is changed.(Inherited from SqlSmoObject.)

System_CAPS_pubeventPropertyMetadataChanged

Represents the event that occurs when property metadata changes.(Inherited from SqlSmoObject.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.Discover()

Discovers any dependencies.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetDomainRoot()

Returns the root of the domain.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.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.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetPropertyType(String)

Gets the type of the specified property.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetPropertyValue(String, Type)

Gets the value of the specified property.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.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.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.Resolve(String)

Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.SetObjectState(SfcObjectState)

Sets the object state to the specified SfcObjectState value.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.SetPropertyValue(String, Type, Object)

Sets the property value.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodISfcPropertyProvider.GetPropertySet()

Gets the interface reference to the set of properties of this object.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

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.

System_CAPS_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.

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.

Return to top
Show:
© 2016 Microsoft