HP Operations Manager for Windows

 

IOvPmdJobScheduler Interface Reference

Interface for the deployment job scheduler. More...

import "pmad.idl";

Inheritance diagram for IOvPmdJobScheduler:

IOvPmdJobScheduler2 IOvPmdJobScheduler80 List of all members.

Public Member Functions
HRESULT  GetJobById ([in]BSTR sJobId,[out, retval]IOvPmdJobEntry **ppEntry)
HRESULT  CancelAllJobs ()
HRESULT  SuspendAllJobs ()
HRESULT  RestartAllJobs ()
HRESULT  CancelJob ([in]BSTR sJobId)
HRESULT  SuspendJob ([in]BSTR sJobId)
HRESULT  RestartJob ([in]BSTR sJobId)

Detailed Description

The interface IOvPmdJobScheduler implements methods to cancel, suspend, and restart deployment jobs.
Since:
6.x

Member Function Documentation

HRESULT IOvPmdJobScheduler::CancelAllJobs (   ) 
 
Semantic:
Removes all jobs in state 'error', 'suspended', and 'pending' from the job queue. Jobs in state 'active' remain in the queue.
Possible errors:
Database communication errors
Since:
6.x
HRESULT IOvPmdJobScheduler::CancelJob (  [in] BSTR  sJobId  ) 
 
Semantic:
Removes the deployment job that is specified by its ID from job queue, even if it is in the state 'active'.
Parameters:
sJobId  - Unique job identifier.
Possible errors:
Database communication errors
Since:
6.x
HRESULT IOvPmdJobScheduler::GetJobById (  [in] BSTR  sJobId,
[out, retval] IOvPmdJobEntry **  ppEntry
) 
 
Semantic:
Returns the job with the ID specified in the first parameter.
Parameters:
sJobId  - Unique job identifier as a string.
ppEntry  - IOvPmdJobEntry interface pointer to the deployment job.
Possible errors:
Database communication errors
Since:
6.x
HRESULT IOvPmdJobScheduler::RestartAllJobs (   ) 
 
Semantic:
Restarts all jobs in state 'error'. They are in state 'active' afterwards. All suspended jobs are moved to state 'pending' by this method.
Possible errors:
Database communication errors
Since:
6.x
HRESULT IOvPmdJobScheduler::SuspendAllJobs (   ) 
 
Semantic:
Sets the state of all pending jobs to 'suspended'.
Possible errors:
Database communication errors
Since:
6.x
HRESULT IOvPmdJobScheduler::SuspendJob (  [in] BSTR  sJobId  ) 
 
Semantic:
Suspends the deployment job that is specified by its ID.
Parameters:
sJobId  - Unique job identifier.
Possible errors:
Database communication errors
Since:
6.x