Share via


JobServer Members

Include Protected Members
Include Inherited Members

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

The JobServer type exposes the following members.

Methods

  Name Description
Protected method AddDatabaseContext(StringCollection) (Inherited from SqlSmoObject.)
Public method Alter() Updates any JobServer object property changes on an instance of SQL Server. 
Protected method AlterImpl() (Inherited from SqlSmoObject.)
Protected method AlterImplFinish(StringCollection, ScriptingOptions) (Inherited from SqlSmoObject.)
Protected method AlterImplInit(StringCollection%, ScriptingOptions%) (Inherited from SqlSmoObject.)
Protected method AlterImplWorker() (Inherited from SqlSmoObject.)
Protected method BindDefaultImpl(String, String, Boolean) (Inherited from SqlSmoObject.)
Protected method BindRuleImpl(String, String, Boolean) (Inherited from SqlSmoObject.)
Protected method CheckCollation(String, ScriptingOptions) (Inherited from SqlSmoObject.)
Protected method CheckObjectState() Validates the state of the referenced object. (Inherited from SqlSmoObject.)
Protected method 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.)
Protected method CheckObjectStateImpl(Boolean) (Inherited from SqlSmoObject.)
Protected method CheckVersion100() (Inherited from SqlSmoObject.)
Protected method CheckVersion80() Checks the validity of the object on SQL Server 2000. (Inherited from SqlSmoObject.)
Protected method CheckVersion80SP3() Checks the validity of the object on SQL Server 2000 SP3. (Inherited from SqlSmoObject.)
Protected method CheckVersion90() Check the validity of the object on SQL Server 2005. (Inherited from SqlSmoObject.)
Protected method CheckVersionBelow90() (Inherited from SqlSmoObject.)
Protected method CleanObject() (Inherited from SqlSmoObject.)
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.
Protected method CreateImpl() (Inherited from SqlSmoObject.)
Protected method CreateImplFinish(StringCollection, ScriptingOptions) (Inherited from SqlSmoObject.)
Protected method CreateImplInit(StringCollection%, ScriptingOptions%) (Inherited from SqlSmoObject.)
Public method CycleErrorLog() Closes and renames the current error log, and then creates a new empty error log file.
Public method Discover() (Inherited from SqlSmoObject.)
Protected method DropImpl() (Inherited from SqlSmoObject.)
Protected method DropImplWorker(Urn%) (Inherited from SqlSmoObject.)
Public method DropJobByID(Guid) Removes the job with the specified ID value.
Public method DropJobsByLogin(String) Removes the job with the specified login name.
Public method DropJobsByServer(String) 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.
Protected method EnumScriptImpl(ScriptingOptions) (Inherited from SqlSmoObject.)
Protected method EnumScriptImplWorker(ScriptingOptions) (Inherited from SqlSmoObject.)
Public method EnumSubSystems() Enumerates a list of SQL Server Agent execution subsystems.
Public method Equals(Object) (Inherited from Object.)
Protected method Finalize() (Inherited from Object.)
Protected method FormatSqlVariant(Object) (Inherited from SqlSmoObject.)
Protected method GenerateDataSpaceFileStreamScript(StringBuilder, ScriptingOptions, Boolean) (Inherited from SqlSmoObject.)
Protected method GenerateDataSpaceScript(StringBuilder, ScriptingOptions) (Inherited from SqlSmoObject.)
Protected method GetBindDefaultScript(ScriptingOptions, String, String, Boolean) (Inherited from SqlSmoObject.)
Protected method GetBindRuleScript(ScriptingOptions, String, String, Boolean) (Inherited from SqlSmoObject.)
Protected method GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%) (Inherited from SqlSmoObject.)
Protected method GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) (Inherited from SqlSmoObject.)
Protected method GetDateTimeParameter(StringBuilder, ScriptingOptions, String, String, Int32%) (Inherited from SqlSmoObject.)
Protected method GetDateTimeParameterAsInt(StringBuilder, ScriptingOptions, String, String, Int32%) (Inherited from SqlSmoObject.)
Protected method GetDBName() Gets the database name that is associated with the object. (Inherited from SqlSmoObject.)
Protected method GetEnumParameter(StringBuilder, ScriptingOptions, String, String, Type, Int32%) (Inherited from SqlSmoObject.)
Protected method GetFragOptionString(FragmentationOption) (Inherited from SqlSmoObject.)
Protected method GetGuidParameter(StringBuilder, ScriptingOptions, String, String, Int32%) (Inherited from SqlSmoObject.)
Public method GetHashCode() (Inherited from Object.)
Public method GetJobByID(Guid) Returns a job with the specified ID value.
Protected method GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%) (Inherited from SqlSmoObject.)
Protected method GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) (Inherited from SqlSmoObject.)
Protected method GetPropValue(String) (Inherited from SqlSmoObject.)
Protected method GetPropValueOptional(String) (Inherited from SqlSmoObject.)
Protected method GetPropValueOptionalAllowNull(String) (Inherited from SqlSmoObject.)
Protected method GetRealValue(Property, Object) (Inherited from SqlSmoObject.)
Protected method GetScriptingOptionsForCreate() (Inherited from SqlSmoObject.)
Protected method GetServerName() Gets the name of the instance of SQL Server with which the object is associated. (Inherited from SqlSmoObject.)
Protected method GetServerObject() (Inherited from SqlSmoObject.)
Protected method GetSqlServerVersionName() Gets the version name of the instance of SQL Server with which the object is associated. (Inherited from SqlSmoObject.)
Protected method GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%) (Inherited from SqlSmoObject.)
Protected method GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) (Inherited from SqlSmoObject.)
Protected method GetTimeSpanParameterAsInt(StringBuilder, ScriptingOptions, String, String, Int32%) (Inherited from SqlSmoObject.)
Public method GetType() (Inherited from Object.)
Protected method GetUrnRecursive(StringBuilder) (Inherited from SqlSmoObject.)
Protected method GetUrnRecursive(StringBuilder, UrnIdOption) (Inherited from SqlSmoObject.)
Protected method ImplInitialize(array<String[], array<OrderBy[]) (Inherited from SqlSmoObject.)
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 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.)
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.)
Protected method IsVersion80SP3() (Inherited from SqlSmoObject.)
Protected method MarkDropped() (Inherited from SqlSmoObject.)
Protected method MarkForDropImpl(Boolean) (Inherited from SqlSmoObject.)
Protected method MemberwiseClone() (Inherited from Object.)
Public method MsxDefect() Ends 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(String, String) Enlists SQL Server Agent as a target server with the specified master server in a multiserver administration.
Protected method PostAlter() (Inherited from SqlSmoObject.)
Protected method PostCreate() (Inherited from SqlSmoObject.)
Protected method PostDrop() (Inherited from SqlSmoObject.)
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(String, String) 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(Guid) Removes a job with a specified ID value.
Public method RemoveJobsByLogin(String) 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.
Protected method ScriptAlter(StringCollection, ScriptingOptions) (Inherited from SqlSmoObject.)
Protected method ScriptCreate(StringCollection, ScriptingOptions) (Inherited from SqlSmoObject.)
Protected method ScriptDdl(StringCollection, ScriptingOptions) (Inherited from SqlSmoObject.)
Protected method ScriptDrop(StringCollection, ScriptingOptions) (Inherited from SqlSmoObject.)
Protected method ScriptImpl() (Inherited from SqlSmoObject.)
Protected method ScriptImpl(ScriptingOptions) (Inherited from SqlSmoObject.)
Protected method ScriptImplWorker(ScriptingOptions) (Inherited from SqlSmoObject.)
Public method SetHostLoginAccount(String, String) 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(SqlSmoObject) (Inherited from SqlSmoObject.)
Public method StartMonitor(String, Int32) 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(String) 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.)
Protected method TouchImpl() (Inherited from SqlSmoObject.)
Protected method UnbindDefaultImpl(Boolean) (Inherited from SqlSmoObject.)
Protected method UnbindRuleImpl(Boolean) (Inherited from SqlSmoObject.)
Public method Validate(String, array<Object[]) (Inherited from SmoObjectBase.)

Top

Fields

  Name Description
Protected field m_ExtendedProperties (Inherited from SqlSmoObject.)

Top

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.
Protected property ExecuteForScalar Gets or sets the Boolean property value that specifies whether the object is set to the execute for scalar option. (Inherited from SqlSmoObject.)
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.
Protected property 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.)
Public property JobCategories Represents a collection of JobCategory objects. Each JobCategory object represents a job category defined on 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.
Protected property 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.)
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 SQL Server Agent.
Public property ReplaceAlertTokensEnabled
Public property SaveInSentFolder Gets or sets the Boolean property value that specifies whether the notifications are saved.
Protected property ScalarResult Gets the scalar result for the referenced object. (Inherited from SqlSmoObject.)
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

Events

  Name Description
Public event PropertyChanged (Inherited from SqlSmoObject.)
Public event PropertyMetadataChanged (Inherited from SqlSmoObject.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IAlienObjectDiscover() (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObjectGetParent() (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObjectGetProperty(String) (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method ISfcPropertyProviderGetPropertySet() (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObjectGetUrn() (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObjectResolve(String) (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObjectSetProperty(Object, Object) (Inherited from SqlSmoObject.)

Top