HP Operations Manager for Windows

 

IOvPmdJobEntry Interface Reference

Interface that represents one deployment job. More...

import "pmad.idl";

Inheritance diagram for IOvPmdJobEntry:

IOvPmdJobEntry80 List of all members.

Public Types
enum   IOvPmdStateEnum { PMD_ACTIVE = 1, PMD_PENDING = 2, PMD_SUSPENDED = 3, PMD_ERROR = 4 }
  Deployment job states. More...
enum   IOvPmdTypeEnum {
  PMD_INSTALL_PACKAGE = 1, PMD_REMOVE_PACKAGE = 2, PMD_INSTALL_POLICY = 3, PMD_REMOVE_POLICY = 4,
  PMD_ENABLE_POLICY = 5, PMD_DISABLE_POLICY = 6, PMD_REDEPLOY_NODE = 7, PMD_UNINSTALL_NODE = 8,
  PMD_DEPLOY_INSTRUMENTATION = 9, PMD_SYNCHRONIZE_NODE = 10, PMD_CHANGE_AGENT = 11
}
  Deployment job types. More...

Public Member Functions
HRESULT  GetNode ([out, retval]IOvPmdNode **ppNode)
HRESULT  GetJobState ([out, retval]IOvPmdStateEnum *pState)
HRESULT  GetJobType ([out, retval]IOvPmdTypeEnum *pType)
HRESULT  GetSchedulingDate ([out, retval]double *dDate)
HRESULT  GetInstance ([out, retval]IDispatch **ppInstance)
HRESULT  GetErrorDescription ([out, retval]BSTR *sError)
HRESULT  GetJobId ([out, retval]BSTR *sJobId)

Detailed Description

The interface IOvPmdJobEntry implements various methods that return the state of a deployment job.
Since:
6.x

Member Enumeration Documentation

enum IOvPmdJobEntry::IOvPmdStateEnum
 
Semantics:
The enumeration defines the possible deployment job states. Only one job per node can be active at the same time.
Since:
6.x
Enumerator:
PMD_ACTIVE  Deployment job is in progress. It is active.
PMD_PENDING  The deployment job is scheduled for a node on which another job is still "Active".
PMD_SUSPENDED  The deployment job is scheduled for the node on which another job is in state "Error".
PMD_ERROR  Deployment job has failed and so it is in state error.
enum IOvPmdJobEntry::IOvPmdTypeEnum
 

The enumeration defines possible deployment job types.

Since:
6.x
Enumerator:
PMD_INSTALL_PACKAGE  Package installation.
PMD_REMOVE_PACKAGE  Package removal.
PMD_INSTALL_POLICY  Policy installation.
PMD_REMOVE_POLICY  Policy removal.
PMD_ENABLE_POLICY  Enable policy.
PMD_DISABLE_POLICY  Disable policy.
PMD_REDEPLOY_NODE  Redeploy packages and policies installation.
PMD_UNINSTALL_NODE  Remove all packages and policies from the node.
PMD_DEPLOY_INSTRUMENTATION  Instrumentation deployment.
PMD_SYNCHRONIZE_NODE  Package synchronization.
PMD_CHANGE_AGENT  Change agent type, binary format, or both.

Member Function Documentation

HRESULT IOvPmdJobEntry::GetErrorDescription (  [out, retval] BSTR *  sError  ) 
 
Semantic:
Returns the description of the error that occurred during execution of the job.
Parameters:
sError  - Error description string.
Possible errors:
Since:
6.x
HRESULT IOvPmdJobEntry::GetInstance (  [out, retval] IDispatch **  ppInstance  ) 
 
Semantic:
Creates a PMAD package or policy version object (depending on the job type), and returns a pointer to the IDispatch interface of the object.
Parameters:
ppInstance  - If the job type is PMD_INSTALL_POLICY, PMD_REMOVE_POLICY, PMD_INSTALL_PACKAGE, PMD_REMOVE_PACKAGE, PMD_ENABLE_POLICY, or PMD_DISABLE_POLICY, this out parameter points to the IDispatch interface of the package or policy version for which the job is executed. For all other job types, a null pointer is returned and the return code is S_FALSE.
Possible errors:
Since:
6.x
HRESULT IOvPmdJobEntry::GetJobId (  [out, retval] BSTR *  sJobId  ) 
 
Semantic:
Returns the ID of the deployment job.
Parameters:
sJobId  - ID of the deployment job as a string.
Possible errors:
Since:
6.x
HRESULT IOvPmdJobEntry::GetJobState (  [out, retval] IOvPmdStateEnum *  pState  ) 
 
Semantic:
Returns the state of the job entry. Possible job states are PMD_PENDING, PMD_ACTIVE, PMD_SUSPENDED, and PMD_ERROR.
Parameters:
pState  - State of the deployment job.
Possible errors:
Since:
6.x
HRESULT IOvPmdJobEntry::GetJobType (  [out, retval] IOvPmdTypeEnum *  pType  ) 
 
Semantic:
Returns the type of the job entry; possible job types are:
Parameters:
pType  - Type of the deployment job.
Possible errors:
Since:
6.x
HRESULT IOvPmdJobEntry::GetNode (  [out, retval] IOvPmdNode **  ppNode  ) 
 
Semantic:
Returns a IOvPmdNode interface pointer to the node object of this job.
Parameters:
ppNode  - Managed node for which the job is executed.
Possible errors:
Since:
6.x
HRESULT IOvPmdJobEntry::GetSchedulingDate (  [out, retval] double *  dDate  ) 
 
Semantic:
Returns date and time when this job was scheduled, or when the state of the job was changed the last time.
Parameters:
dDate  - Data and time when the job state changed the last time.
Possible errors:
Since:
6.x