Class CIM_BasicExecutionService
extends CIM_Service

The basic execution service (BES)is a service to which clients can send requests to initiate, monitor, and manage computational activities and access information about the BES. A BasicExecutionService can act on one or more execution environments - modeled, profiled, and instantiated as a ComputerSystem. There is no requirement that a BasicExecutionService reside on the node of a ComputerSystem on which it acts. The associations ServiceAvailToElement and ServiceAffectsElement relate the BasicExecutionService to ComputerSystem. The association HostedDependency expresses the concept that an execution environment may be contained within another execution environment. For example, in a grid or distributed/virtualized environment the whole point for not explicitly stating which execution environment to use up front is to allow some client software, e.g. scheduler, orchestrator, provisioner, application, to determine where to place the activity (in which execution environment) based on the input activity document (that activity's environment/resource requirements).

Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods


Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_ManagedSystemElement
   |
   +--CIM_LogicalElement
   |
   +--CIM_EnabledLogicalElement
   |
   +--CIM_Service
   |
   +--CIM_BasicExecutionService

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
DescriptionstringThe basic execution service (BES)is a service to which clients can send requests to initiate, monitor, and manage computational activities and access information about the BES. A BasicExecutionService can act on one or more execution environments - modeled, profiled, and instantiated as a ComputerSystem. There is no requirement that a BasicExecutionService reside on the node of a ComputerSystem on which it acts. The associations ServiceAvailToElement and ServiceAffectsElement relate the BasicExecutionService to ComputerSystem. The association HostedDependency expresses the concept that an execution environment may be contained within another execution environment. For example, in a grid or distributed/virtualized environment the whole point for not explicitly stating which execution environment to use up front is to allow some client software, e.g. scheduler, orchestrator, provisioner, application, to determine where to place the activity (in which execution environment) based on the input activity document (that activity's environment/resource requirements).
Experimentalbooleantrue
UMLPackagePathstringCIM::Core::Grid
Versionstring2.16.0

Class Properties

Inherited Properties

NameData TypeClass Origin
CaptionstringCIM_ManagedElement
CommunicationStatusuint16CIM_ManagedSystemElement
CreationClassNamestringCIM_Service
DescriptionstringCIM_ManagedElement
DetailedStatusuint16CIM_ManagedSystemElement
ElementNamestringCIM_ManagedElement
EnabledDefaultuint16CIM_EnabledLogicalElement
EnabledStateuint16CIM_EnabledLogicalElement
Generationuint64CIM_ManagedElement
HealthStateuint16CIM_ManagedSystemElement
InstallDatedatetimeCIM_ManagedSystemElement
InstanceIDstringCIM_ManagedElement
NamestringCIM_Service
OperatingStatusuint16CIM_ManagedSystemElement
OtherEnabledStatestringCIM_EnabledLogicalElement
PrimaryOwnerContactstringCIM_Service
PrimaryOwnerNamestringCIM_Service
PrimaryStatusuint16CIM_ManagedSystemElement
RequestedStateuint16CIM_EnabledLogicalElement
StartedbooleanCIM_Service
StartModestringCIM_Service
StatusstringCIM_ManagedSystemElement
SystemCreationClassNamestringCIM_Service
SystemNamestringCIM_Service
TimeOfLastStateChangedatetimeCIM_EnabledLogicalElement
TransitioningToStateuint16CIM_EnabledLogicalElement
AvailableRequestedStatesuint16[]CIM_EnabledLogicalElement
OperationalStatusuint16[]CIM_ManagedSystemElement
StatusDescriptionsstring[]CIM_ManagedSystemElement

Class Methods

Local Class Methods

CreateActivity (uint32)

Method Qualifiers (CreateActivity)

NameData TypeValue
DescriptionstringThis operation adds requests to the execution environment. For example, within the context of the OGSA Basic Execution Services, this means that a new activity is added to an execution environment, and the operation maps to the CreateActivity() interface. CreateActivity establishes the 'binding' between the activity and the execution environment that will contain it. Selection / implementation of how an execution environment is outside the scope of basic execution service. In a grid or distributed environment, this allows other clients, e.g. schedulers, orchestrators, applications, to make decisions on which execution environment to select (place activity) based on the JSDL job description (the input activity document that describes that activity's environment/resource requirements. The return value should be 0 if the request was successfully executed and some other value if an error occurred. The output the CreateActivity method is an identifier which is used as input to other methods in this class to identify the activity being acted upon.
MappingStringsstringMIF.OGF|GFD.108|CreateActivity.Faults
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 4097..32767, 32768..65535
ValuesstringOperation Completed with No Error, Not Supported, Unknown, Not Authorized, Not Accepting New Activities, Unsupported Feature, Invalid Request Message, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

Method Parameters (CreateActivity)

NameTypeQualifiers
NameData TypeValue
Identifierstring
DescriptionstringIdentifier associated with the requested execution. This Identifier is used as input to other Basic Execution service methods.
INbooleanfalse
MappingStringsstringMIF.OGF|GFD.108|CreateActivity.Response, MIF.OASIS|WS-Addressing, MIF.OGF|GFD.56|jsdl:JobDefinition
OUTbooleantrue
Requeststring
DescriptionstringDescribes a single request that is to be executed by an execution environment.
INbooleantrue
MappingStringsstringMIF.OGF|GFD.108|CreateActivity.ActivityDocument, MIF.OGF|GFD.56|jsdl:JobDefinition
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (can be null if the task is completed).
INbooleanfalse
OUTbooleantrue

TerminateActivity (uint32)

Method Qualifiers (TerminateActivity)

NameData TypeValue
DescriptionstringThis operation requests that one or more items in an execution environment be terminated. For example, within the context of the OGSA Basic Execution Services, this means that a new or existing activity in the container can be requested to be terminated, and the operation maps to the TerminateActivities() interface. The return value should be 0 if the request was successfully executed and some other value if an error occurred. The return code Invalid Request Message refers to the input of an invalid identifier.
MappingStringsstringMIF.OGF|GFD.108|TerminateActivities.Faults
ValueMapstring0, 1, 2, 3, .., 4096, 4097..32767, 32768..65535
ValuesstringOperation Completed with No Error, Not Supported, Unknown, Invalid Activity Identifer, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

Method Parameters (TerminateActivity)

NameTypeQualifiers
NameData TypeValue
Identifierstring[]
DescriptionstringIdentifies one or more items in an execution environment that are to be terminated.
INbooleantrue
MappingStringsstringMIF.OGF|GFD.108|TerminateActivities.ActivityIdentifiers, MIF.OASIS|WS-Addressing
Responseboolean[]
DescriptionstringBoolean response value for each requested termination. A value of TRUE indicates successful termination.
INbooleanfalse
MappingStringsstringMIF.OGF|GFD.108|TerminateActivities.Response
OUTbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (can be null if the task is completed).
INbooleanfalse
OUTbooleantrue

GetActivityStatus (uint32)

Method Qualifiers (GetActivityStatus)

NameData TypeValue
DescriptionstringThis operation requests the status of one or more items in an execution environment. For example, within the context of the OGSA Basic Execution Services, this means that the status of one or more activities within an execution environment can be obtained, and the operation maps to the GetActivityStatuses() interface. The return value should be 0 if the request was successfully executed and some other value if an error occurred. The return code Invalid Request Message refers to the input of an invalid identifier.
MappingStringsstringMIF.OGF|GFD.108|GetActivityStatuses.Faults
ValueMapstring0, 1, 2, 3, .., 4096, 4097..32767, 32768..65535
ValuesstringOperation Completed with No Error, Not Supported, Unknown, Invalid Activity Identifier, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

Method Parameters (GetActivityStatus)

NameTypeQualifiers
NameData TypeValue
Identifierstring[]
DescriptionstringIdentifies one or more items in an execution environment whose status will be obtained.
INbooleantrue
MappingStringsstringMIF.OGF|GFD.108|GetActivityStatuses.ActivityIdentifiers, MIF.OASIS|WS-Addressing
StatusResponsestring[]
DescriptionstringA response for each requested status.
INbooleanfalse
MappingStringsstringMIF.OGF|GFD.108|GetActivityStatuses.Response
OUTbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (can be null if the task is completed).
INbooleanfalse
OUTbooleantrue

GetActivityDocuments (uint32)

Method Qualifiers (GetActivityDocuments)

NameData TypeValue
DescriptionstringThis operation requests activity document descriptions for a set of specified set of activities. These activity documents may be different from those initially input in the CreateActivity operation since this service may alter its contents to reflect policy or process within the service. The return code Invalid Request Message refers to the input of an invalid identifier.
MappingStringsstringMIF.OGF|GFD.108|GetActivityDocuments.Faults
ValueMapstring0, 1, 2, 3, .., 4096, 4097..32767, 32768..65535
ValuesstringOperation Completed with No Error, Not Supported, Unknown, Invalid Activity Identifier, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

Method Parameters (GetActivityDocuments)

NameTypeQualifiers
NameData TypeValue
Identifierstring[]
DescriptionstringIdentifies one or more activities for which activity documents are requested.
INbooleantrue
MappingStringsstringMIF.OGF|GFD.108|GetActivityDocuments.ActivityIdentifiers, MIF.OASIS|WS-Addressing
Responsestring[]
DescriptionstringAn array of activity document response elements.
INbooleanfalse
MappingStringsstringMIF.OGF|GFD.108|GetActivityDocuments.Response
OUTbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (can be null if the task is completed).
INbooleanfalse
OUTbooleantrue

GetAttributesDocument (uint32)

Method Qualifiers (GetAttributesDocument)

NameData TypeValue
DescriptionstringThis operation requests a document containing the basic execution service management attributes.The return code Invalid Request Message refers to the input of an invalid identifier.
MappingStringsstringMIF.OGF|GFD.108|GetAttributesDocument.Faults
ValueMapstring0, 1, 2, .., 4096, 4097..32767, 32768..65535
ValuesstringOperation Completed with No Error, Not Supported, Unknown, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

Method Parameters (GetAttributesDocument)

NameTypeQualifiers
NameData TypeValue
AttrsDocstring[]
DescriptionstringA XML document containing the various attributes within its associated container.
INbooleanfalse
MappingStringsstringMIF.OGF|GFD.108|GetAttributesDocument.BESResourceAttributesDocument, MIF.OGF|GFD.56|JSDL Core Element Set and Appendix 1
OUTbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (can be null if the task is completed).
INbooleanfalse
OUTbooleantrue

Inherited Class Methods

NameReturn TypeClass Origin
ChangeAffectedElementsAssignedSequenceuint32CIM_Service
RequestStateChangeuint32CIM_EnabledLogicalElement
StartServiceuint32CIM_Service
StopServiceuint32CIM_Service