.png)
JobServer Class
SQL Server 2008 R2
The JobServer object represents the SQL Server Agent subsystem and the msdb database.
System.Object
Microsoft.SqlServer.Management.Smo.SmoObjectBase
Microsoft.SqlServer.Management.Smo.SqlSmoObject
Microsoft.SqlServer.Management.Smo.Agent.JobServer
Microsoft.SqlServer.Management.Smo.SmoObjectBase
Microsoft.SqlServer.Management.Smo.SqlSmoObject
Microsoft.SqlServer.Management.Smo.Agent.JobServer
Assembly: Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)
The JobServer type exposes the following members.
| Name | Description | |
|---|---|---|
 | AgentDomainGroup | Gets the SQL Server Agent domain group. |
| AgentLogLevel | Gets or sets the type of messages that are logged by SQL Server Agent. |
| AgentMailType | Gets or sets the mail type for SQL Server Agent. |
| AgentShutdownWaitTime | Gets or sets the time that SQL Server Agent waits for jobs to complete execution before shutting down. |
| AlertCategories | Represents a collection of AlertCategory objects. Each AlertCategory object represents an alert category defined on SQL Server Agent. |
| Alerts | Represents a collection of Alert objects. Each Alert object represents an alert defined on SQL Server Agent. |
| AlertSystem | The AlertSystem object stores information that applies to all the alerts defined on SQL Server Agent. |
| DatabaseMailProfile | Gets or sets a Database Mail profile. |
| ErrorLogFile | Gets or sets the name and path of the file in which SQL Server Agent records errors. |
| ExecuteForScalar | Gets or sets the Boolean property value that specifies whether the object is set to the execute for scalar option. (Inherited from SqlSmoObject.) |
| HostLoginName | Gets or sets the login used to log in to SQL Server. |
| 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. |
| IdleCpuPercentage | Gets or sets the CPU idle percentage threshold that the processor is required to achieve before it is considered idle. |
| IsCpuPollingEnabled | Gets or sets the Boolean property value that specifies whether CPU polling is enabled. |
| IsTouched | Gets the Boolean property value that specifies whether the object properties have been updated but not yet persisted on the server. (Inherited from SqlSmoObject.) |
| JobCategories | Represents a collection of JobCategory objects. Each JobCategory object represents a job category defined on Microsoft SQL Server Agent. |
| Jobs | Represents a collection of Job objects. Each Job object represents a job defined on SQL Server Agent. |
| JobServerType | Gets or sets the type of job server with regard to multiserver administration. |
| LocalHostAlias | Gets or sets the local host alias that is used to connect to the local instance of SQL Server. |
| LoginTimeout | Gets or sets the number of seconds after which an attempt to connect times out. |
| MaximumHistoryRows | Gets or sets the maximum number of history rows retained. |
| MaximumJobHistoryRows | Gets or sets the maximum number of history rows retained per job. |
| MsxAccountCredentialName | Gets or sets the Windows account required to connect to the master server using Windows Authentication. |
| MsxAccountName | Gets or sets the login required to connect to the master server using SQL Server Authentication. |
| MsxServerName | Gets or sets the name of the master server participating in multiserver administration. |
| Name | Gets the name of the SQL Server Agent service. |
| NetSendRecipient | Gets or sets the recipient of net send messages. |
| ObjectInSpace | Gets the Boolean property value that specifies whether the object exists in isolation, or whether it is directly or indirectly connected to the instance of SQL Server. (Inherited from SqlSmoObject.) |
| OperatorCategories | Represents a collection of OperatorCategory objects. Each OperatorCategory object represents an operator category defined on SQL Server Agent. |
| Operators | Represents a collection of Operator objects. Each Operator object represents an operator defined on SQL Server Agent. |
| Parent | Gets the Server object that is the parent of the JobServer object. |
| Properties | Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.) |
| ProxyAccounts | Represents a collection of ProxyAccount objects. Each ProxyAccount object represents a proxy account defined on Microsoft SQL Server Agent. |
| ReplaceAlertTokensEnabled | Gets or sets the Boolean value that determines whether alert tokens are replaced on the instance of SQL Server Agent. |
| SaveInSentFolder | Gets or sets the Boolean property value that specifies whether the notifications are saved. |
| ScalarResult | Gets the scalar result for the referenced object. (Inherited from SqlSmoObject.) |
| ServiceAccount | Gets the account under which the SQL Server Agent service runs |
| ServiceStartMode | Gets the mode used to start the SQL Server Agent service. |
| SharedSchedules | Represents a collection of JobSchedule objects. Each JobSchedule object represents a shared schedule defined on SQL Server Agent. |
| SqlAgentAutoStart | Gets or sets the Boolean property value that specifies whether SQL Server Agent is automatically started. |
| SqlAgentMailProfile | Gets or sets a SQL Server Agent mail profile. |
| SqlAgentRestart | Gets or sets the Boolean property value that specifies whether SQL Server Agent is monitored and restarted if it stops. |
| SqlServerRestart | Gets or sets the Boolean property value that specifies whether the SQL Server Service is monitored and restarted if it stops. |
| State | Gets the state of the referenced object. (Inherited from SmoObjectBase.) |
| 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. |
| TargetServerGroups | Represents a collection of TargetServerGroup objects. Each TargetServerGroup object represents a target server group defined on SQL Server Agent. |
| TargetServers | Represents a collection of TargetServer objects. Each TargetServer object represents a target server defined on SQL Server Agent. |
| Urn | Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.) |
| UserData | Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.) |
| WriteOemErrorLog | Gets or sets the Boolean property value that specifies whether to write the error log to a non-Unicode file or not. |
| Name | Description | |
|---|---|---|
| AddDatabaseContext(StringCollection) | Add the database context to the collection of queries identified by the queries parameter. (Inherited from SqlSmoObject.) |
| AddDatabaseContext(StringCollection, ScriptingOptions) | Add the database context to the collection of queries identified by the queries parameter, and using the specified scripting options. (Inherited from SqlSmoObject.) |
| Alter | Updates any JobServer object property changes on an instance of SQL Server. |
| AlterImpl | Activates the object altered event. (Inherited from SqlSmoObject.) |
| AlterImplFinish | Method called when object altered event finishes. (Inherited from SqlSmoObject.) |
| AlterImplInit | Method called when object-altered event is intialized. (Inherited from SqlSmoObject.) |
| AlterImplWorker | Calls the Alter methods. (Inherited from SqlSmoObject.) |
| BindDefaultImpl | Binds the default items identified by the parameters. (Inherited from SqlSmoObject.) |
| BindRuleImpl | Binds the rule schema to the rule and columns identified by the parameters. (Inherited from SqlSmoObject.) |
| CheckCollation | Checks the order of the scripting options by the collation method identified by the collationName parameter. (Inherited from SqlSmoObject.) |
| CheckObjectState() | Validates the state of the referenced object. (Inherited from SqlSmoObject.) |
| CheckObjectState(Boolean) | Validates the state of the referenced object with the option to specify that an exception is thrown if the object is not yet created. (Inherited from SqlSmoObject.) |
| CheckObjectStateImpl | Checks the state of a SqlSmoObject. (Inherited from SqlSmoObject.) |
| CheckVersion100 | Checks whether version of SQL Server is SQL Server 2008. (Inherited from SqlSmoObject.) |
| CheckVersion80 | Checks the validity of the object on SQL Server 2000. (Inherited from SqlSmoObject.) |
| CheckVersion80SP3 | Checks the validity of the object on SQL Server 2000 SP3. (Inherited from SqlSmoObject.) |
| CheckVersion90 | Check the validity of the object on SQL Server 2005. (Inherited from SqlSmoObject.) |
| CheckVersionBelow90 | Checks whether version of SQL Server is before SQL Server 2005. (Inherited from SqlSmoObject.) |
| CleanObject | Sets the object to unmodified state. (Inherited from SqlSmoObject.) |
| ClearHostLoginAccount | Clears the host login account and uses integrated security to log in to SQL Server. |
| ClearMsxAccount | Clears the master server login account and uses integrated security to log in to the master server. |
| CreateImpl | Creates an object with scripting options. (Inherited from SqlSmoObject.) |
| CreateImplFinish | Method called when the create event finishes. (Inherited from SqlSmoObject.) |
| CreateImplInit | Method called when the create event initializes. (Inherited from SqlSmoObject.) |
| CycleErrorLog | Closes and renames the current error log, and then creates a new empty error log file. |
| Discover | Discovers a list of type Object. (Inherited from SqlSmoObject.) |
| DropImpl | Drops a SqlSmoObject. (Inherited from SqlSmoObject.) |
| DropImplWorker | Calls the drop methods. (Inherited from SqlSmoObject.) |
| DropJobByID | Removes the job with the specified ID value. |
| DropJobsByLogin | Removes the job with the specified login name. |
| DropJobsByServer | Removes the job with the specified server. |
| EnumErrorLogs | Enumerates a list of SQL Server Agent error log information. |
| EnumJobHistory() | Enumerates a list of SQL Server Agent job history information. |
| EnumJobHistory(JobHistoryFilter) | Enumerates a list of job history information. |
| EnumJobs() | Enumerates a list of information about the current job. |
| EnumJobs(JobFilter) | Enumerates a list of information about current jobs. |
| EnumPerformanceCounters() | Enumerates a list of SQL Server Agent performance counter information. |
| EnumPerformanceCounters(String) | Enumerates a list of SQL Server Agent performance counter information for the specified object. |
| EnumPerformanceCounters(String, String) | Enumerates a list of SQL Server Agent performance counter information for the specified object and specified counter. |
| 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. |
| EnumScriptImpl | Enumerates scripts specified by the so parameter. (Inherited from SqlSmoObject.) |
| EnumScriptImplWorker | Calls the methods that enumerate scripts specified by the so parameter. (Inherited from SqlSmoObject.) |
| EnumScriptImplWorkerSOChanged | Returns an IEnumerable string describing the scripting options for an object. (Inherited from SqlSmoObject.) |
| EnumSubSystems | Enumerates a list of SQL Server Agent execution subsystems. |
| Equals | (Inherited from Object.) |
| ExecuteNonQuery | Executes a batch in the context of the database where there are no results returned. (Inherited from SqlSmoObject.) |
| Finalize | (Inherited from Object.) |
| FormatSqlVariant | Formats an object as SqlVariant type. (Inherited from SqlSmoObject.) |
| GenerateDataSpaceFileStreamScript | Generates a script to create data file. (Inherited from SqlSmoObject.) |
| GenerateDataSpaceScript | Generates a script to allocate space in the data file. (Inherited from SqlSmoObject.) |
| GetBindDefaultScript | Gets the script that binds defaults specified by the defSchema and defName parameters. (Inherited from SqlSmoObject.) |
| GetBindRuleScript | Gets the script that specifies the binding rules. (Inherited from SqlSmoObject.) |
| GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32) | Assigns a Boolean parameter of the SqlSmoObject. (Inherited from SqlSmoObject.) |
| GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32, Boolean) | Assigns a Boolean property of the SqlSmoObject. (Inherited from SqlSmoObject.) |
| GetDateTimeParameter | Assigns the datetime property of the SqlSmoObject. (Inherited from SqlSmoObject.) |
| GetDateTimeParameterAsInt | Assigns the datetime property of the SqlSmoObject as an integer value if the datetime property is not null. (Inherited from SqlSmoObject.) |
| GetDBName | Gets the database name that is associated with the object. (Inherited from SqlSmoObject.) |
| GetEnumParameter | Assigns an enumeration property of the SqlSmoObject. (Inherited from SqlSmoObject.) |
| GetFragOptionString | Gets a FragmentationOption object as a string value. (Inherited from SqlSmoObject.) |
| GetGuidParameter | Assigns a Guid property of the SqlSmoObject. (Inherited from SqlSmoObject.) |
| GetHashCode | (Inherited from Object.) |
| GetJobByID | Returns a job with the specified ID value. |
| GetParameter(StringBuilder, ScriptingOptions, String, String, Int32) | Assigns a parameter of the SqlSmoObject. (Inherited from SqlSmoObject.) |
| GetParameter(StringBuilder, ScriptingOptions, String, String, Int32, Boolean) | Assigns a parameter of the SqlSmoObject. (Inherited from SqlSmoObject.) |
| GetPropValue | Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.) |
| GetPropValueOptional | Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.) |
| GetPropValueOptionalAllowNull | Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.) |
| GetRealValue | Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.) |
| GetScriptingOptionsForCreate | Gets ScriptingOptions for the SqlSmoObject object. (Inherited from SqlSmoObject.) |
| GetServerName | Gets the name of the instance of SQL Server with which the object is associated. (Inherited from SqlSmoObject.) |
| GetServerObject | Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.) |
| GetSqlServerVersionName | Gets the version name of the instance of SQL Server with which the object is associated. (Inherited from SqlSmoObject.) |
| GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32) | Assigns a string parameter of the SqlSmoObject object. (Inherited from SqlSmoObject.) |
| GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32, Boolean) | Assigns a string parameter of the SqlSmoObject object. (Inherited from SqlSmoObject.) |
| GetTimeSpanParameterAsInt | Assigns a time span parameter of the SqlSmoObject object. (Inherited from SqlSmoObject.) |
| GetType | (Inherited from Object.) |
| GetUrnRecursive(StringBuilder) | Assigns an Urn object of the SqlSmoObject object. (Inherited from SqlSmoObject.) |
| GetUrnRecursive(StringBuilder, UrnIdOption) | Assigns an Urn object of the SqlSmoObject object. (Inherited from SqlSmoObject.) |
| ImplInitialize | Initializes the fields of the SqlSmoObject object. (Inherited from SqlSmoObject.) |
| Initialize() | Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.) |
| Initialize(Boolean) | Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.) |
| IsObjectDirty | Verifies whether the object properties have been modified and the changes have not yet been persisted on the instance of SQL Server. (Inherited from SqlSmoObject.) |
| IsObjectInitialized | Verifies whether the object has been initialized. (Inherited from SqlSmoObject.) |
| IsObjectInSpace | Verifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.) |
| IsVersion80SP3 | Determines whether the version of SQL Server is SQL Server 2000 with SP3. (Inherited from SqlSmoObject.) |
| IsVersion90AndAbove | Determines whether the version of SQL Server is SQL Server 2005 or later. (Inherited from SqlSmoObject.) |
| MarkDropped | Sets the SqlSmoState to dropped. (Inherited from SqlSmoObject.) |
| MarkForDropImpl | Sets the SqlSmoState to dropped. (Inherited from SqlSmoObject.) |
| MemberwiseClone | (Inherited from Object.) |
| MsxDefect() | Ends Microsoft SQL Server Agent participation in a multiserver administration group. |
| MsxDefect(Boolean) | Ends SQL Server Agent participation in a multiserver administration group with the option to force defection. |
| MsxEnlist | Enlists SQL Server Agent as a target server with the specified master server in a multiserver administration. |
| PostAlter | Method activated after the SqlSmoObject is altered. (Inherited from SqlSmoObject.) |
| PostCreate | Method activated after the SqlSmoObject is created. (Inherited from SqlSmoObject.) |
| PostDrop | Method activated after the SqlSmoObject is dropped. (Inherited from SqlSmoObject.) |
| PurgeJobHistory() | Removes all logged records of SQL Server Agent jobs. |
| PurgeJobHistory(JobHistoryFilter) | Removes all logged records of SQL Server Agent jobs as specified by a filter. |
| ReadErrorLog() | Enumerates the error log. |
| ReadErrorLog(Int32) | Enumerates the error log. |
| ReassignJobsByLogin | Changes ownership for any SQL Server Agent job currently owned by a SQL Server login. |
| Refresh | Refreshes the object and retrieves properties when the object is next accessed. (Inherited from SqlSmoObject.) |
| RemoveJobByID | Removes a job with a specified ID value. |
| RemoveJobsByLogin | Removes a job with a specified login. |
| Script() | Generates a Transact-SQL script that can be used to re-create SQL Server Agent. |
| Script(ScriptingOptions) | Generates a Transact-SQL script that can be used to re-create SQL Server Agent as specified by the scripting options. |
| ScriptAlter | Alters the SqlSmoObject according to the parameters. (Inherited from SqlSmoObject.) |
| ScriptCreate | Alters the SqlSmoObject according to the parameters. (Inherited from SqlSmoObject.) |
| ScriptDdl | Throws InvalidSmoOperationException. (Inherited from SqlSmoObject.) |
| ScriptDrop | Throws InvalidSmoOperationException. (Inherited from SqlSmoObject.) |
| ScriptImpl() | Gets a collection of scripts of the SqlSmoObject. (Inherited from SqlSmoObject.) |
| ScriptImpl(ScriptingOptions) | Gets a collection of scripts of the SqlSmoObject. (Inherited from SqlSmoObject.) |
| ScriptImplWorker | Gets a collection of scripts of the SqlSmoObject. (Inherited from SqlSmoObject.) |
| SetHostLoginAccount | Sets the SQL Server authentication account and password used to log in to SQL Server. |
| SetMsxAccount(String) | Sets the name of the credentials used to log in to the master server in multiserver administration. |
| SetMsxAccount(String, String) | Sets the name of the credentials used to log in to the master server in multiserver administration. |
| SetParentImpl | Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.) |
| StartMonitor | Starts monitoring the local SQL Server Agent Service by an instance of SQL Server. |
| StopMonitor | Ends monitoring the local SQL Server Agent Service by an instance of SQL Server. |
| TestMailProfile | Tests the validity of an e-mail profile. |
| TestNetSend | Tests the validity of a net send address. |
| ToString | Returns a String that represents the referenced object. (Inherited from SqlSmoObject.) |
| TouchImpl | Not implemented. (Inherited from SqlSmoObject.) |
| UnbindDefaultImpl | Unbinds the default columns of the SqlSmoObject. (Inherited from SqlSmoObject.) |
| UnbindRuleImpl | Unbinds rules of the SqlSmoObject. (Inherited from SqlSmoObject.) |
| Validate | Validates the state of an object. (Inherited from SmoObjectBase.) |
| Name | Description | |
|---|---|---|
| PropertyChanged | Represents the event that occurs when a property is changed. (Inherited from SqlSmoObject.) |
| PropertyMetadataChanged | Represents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.) |
| Name | Description | |
|---|---|---|
| m_ExtendedProperties | Represents a property that is defined to extend the properties provided by a SqlSmoObject. (Inherited from SqlSmoObject.) |
| singletonParent | Represents the singleton parent. (Inherited from SqlSmoObject.) |
| Name | Description | |
|---|---|---|
| IAlienObject.Discover | Discovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.) |
| IAlienObject.GetDomainRoot | Returns the root of the domain. (Inherited from SqlSmoObject.) |
| 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.) |
| IAlienObject.GetPropertyType | Gets the type of the specified property. (Inherited from SqlSmoObject.) |
| IAlienObject.GetPropertyValue | Gets the value of the specified property. (Inherited from SqlSmoObject.) |
| IAlienObject.GetUrn | Gets the Unified Resource Name of the object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.) |
| IAlienObject.Resolve | Gets the instance that contains the information about the object from the Unified Resource Name of the object. (Inherited from SqlSmoObject.) |
| IAlienObject.SetObjectState | Sets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.) |
| IAlienObject.SetPropertyValue | Sets the property value. (Inherited from SqlSmoObject.) |
| ISfcPropertyProvider.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.
| 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.
