Class CIM_LaunchInContextSAP
extends CIM_RemoteServiceAccessPoint

Each instance provides a flexible representation of a URI stored in the AccessInfo property that is used to launch a management service. This URI may contain dynamic information in the form of parameters that can used to modify the URI for use in a specific context.

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


Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_ManagedSystemElement
   |
   +--CIM_LogicalElement
   |
   +--CIM_EnabledLogicalElement
   |
   +--CIM_ServiceAccessPoint
   |
   +--CIM_RemoteServiceAccessPoint
   |
   +--CIM_LaunchInContextSAP

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
ClassConstraintstringinv: AccessContext=10, inv: InfoFormat=200 or InfoFormat=206
DescriptionstringEach instance provides a flexible representation of a URI stored in the AccessInfo property that is used to launch a management service. This URI may contain dynamic information in the form of parameters that can used to modify the URI for use in a specific context.
UMLPackagePathstringCIM::Core::LaunchInContext
Versionstring2.27.0

Class Properties

Local Class Properties

NameData TypeDefault ValueQualifiers
NameData TypeValue
AccessContextuint16
DescriptionstringAccessContext shall specify a Management Service (10).
ModelCorrespondencestringCIM_RemoteServiceAccessPoint.OtherAccessContext
OverridestringAccessContext
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, .., 32768..65535
ValuesstringUnknown, Other, Default Gateway, DNS Server, SNMP Trap Destination, MPLS Tunnel Destination, DHCP Server, SMTP Server, LDAP Server, Network Time Protocol (NTP) Server, Management Service, DMTF Reserved, Vendor Reserved
AccessInfostring
DescriptionstringThe URL may contain ${ParameterName} strings. The client is responsible for replacing such strings with the values of the corresponding parameters. (See the properties Parameter<Name, Description, Type, Constraint, and Derivation> below for various ways for a client to obtain those values.
ModelCorrespondencestringCIM_LaunchInContextSAP.ParameterName, CIM_LaunchInContextSAP.InfoFormat
OverridestringAccessInfo
InfoFormatuint16
DescriptionstringInfoFormat shall contain either 200(URL) or 206(Paramterized URL).
ModelCorrespondencestringCIM_RemoteServiceAccessPoint.OtherInfoFormatDescription
OverridestringInfoFormat
ValueMapstring1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 100, 101, 102, 103, 104, 200, 201, 202, 203, 204, 205, 206, .., 32768..65535
ValuesstringOther, Host Name, IPv4 Address, IPv6 Address, IPX Address, DECnet Address, SNA Address, Autonomous System Number, MPLS Label, IPv4 Subnet Address, IPv6 Subnet Address, IPv4 Address Range, IPv6 Address Range, Dial String, Ethernet Address, Token Ring Address, ATM Address, Frame Relay Address, URL, FQDN, User FQDN, DER ASN1 DN, DER ASN1 GN, Key ID, Parameterized URL, DMTF Reserved, Vendor Reserved
LaunchMessagestring
DescriptionstringLaunchMessage is a template for a message, to be sent to the URL specified in the AccessContext property. Like the AccessInfo property, this template may contain parameter value placeholders as ${ParameterName}, where ParameterName matches an entry in the ParameterName property. The format of the template is defined by the protocol specified by the value of the LaunchMessageProtocol. The client that uses this information to send a request is responsible for understanding the side-effects of passing the message. For instance if the message causes a service to be invoked, the client is responsible for handling reply messages.
ModelCorrespondencestringCIM_LaunchInContextSAP.LaunchMessageProtocolOperation
LaunchMessageProtocolOperationuint163
DescriptionstringThis enumeration defines the protocol used to send the LaunchMessage. The format shall be orgName:protocolName:protocolVersion:protocolOperation,where orgName shall be a trademarked, or otherwise owned name of the defining organization, protocolName together with protocolVersion shall name protocol defined by that organization and protocolOperation shall name an operation of the protocol.
ValueMapstring2, 3, 4, 5, .., 32768..65535
ValuesstringIETF:HTTP:1.0:GET, IETF:HTTP:1.0:POST, IETF:HTTP:1.1:GET, IETF:HTTP:1.1:POST, DMTF Reserved, Vendor Specific
ManagementIsRestrictedbooleanfalse
DescriptionstringThis property, together with ManagementIsRestricted defines the set of instances exposed in the namespace of this instance, that may be managed by the service addressed by this instance. If the value of this boolean is false, then all instances exposed by the namespace which are kinds of the classes named in the entries of ManagedClasses may be managed by the addressed service. If true, then only those instances that are associated via CIM_ManagedSAP may be managed by the addressed service. This value shall be true if such associations exist.
ModelCorrespondencestringCIM_LaunchInContextSAP.ManagedClasses
ManagedClassesstring[]
DescriptionstringThis property, together with ManagementIsRestricted defines the set of instances exposed in the namespace of this instance, that may be managed by the service addressed by this instance. The entries of this property identify the classes that such instances must be a kind of.
ModelCorrespondencestringCIM_LaunchInContextSAP.ManagementIsRestricted
ParameterConstraintsstring[]
ArrayTypestringIndexed
DescriptionstringEach non-empty entry specifies additional constraints on the corresponding parameter value beyond those that can be inferred from the corresponding ParameterType entry. Each entry shall be empty if the corresponding ParameterDerivation value is not empty or null. Otherwise, this shall be an OCL Invariant constraint that limits the values of the string. The OCL context, and therefore, the 'self' variable shall refer to the parameter's value. For patterns, the OCL syntax is extended to include the use string function 'Like()' with the regular expression grammar as defined in DSP0200 Annex C, (http://www.dmtf.org/standards/published_documents/DSP0202_1.0.0.pdf).
ModelCorrespondencestringCIM_LaunchInContextSAP.ParameterName
ParameterDerivationstring[]
ArrayTypestringIndexed
DescriptionstringEach non empty entry shall specify a derivation for the value of the corresponding ParameterName property. Each derivation shall be specified as an OCL Derive constraint. (See OMG Object Constraint Language, v2.0, http://www.omg.org/technology/documents/spec_catalog.htm) If specified, the derivation context is an instance of CIM_ManagedElement specified in the GetDerivedParametersForElement method of this class. The derivation context and the 'derive:' keywords are not explicitly specified here. Example: to return the Caption of the specified element, the entry would contain the string: "self.Caption". On retrieval, the values returned by the method are used to replace the corresponding ${ParameterName} string in Accessinfo or LaunchMessage.
ModelCorrespondencestringCIM_LaunchInContextSAP.ParameterName, CIM_LaunchInContextSAP.GetDerivedparametersForElement
ParameterDescriptionstring[]
ArrayTypestringIndexed
DescriptionstringProvides information about each parameter to display for each entry.
ModelCorrespondencestringCIM_LaunchInContextSAP.ParameterName
ParameterNamestring[]
ArrayTypestringIndexed
DescriptionstringEach entry specifies the name of a parameter specified in the URL string stored in the AccessInfo property as ${ParameterName}. Parameter names should have the format orgName:specName:specVersion:parameterName. In this format: orgName shall be a trademarked, or otherwise owned name of the defining organization, specName together with specVersion shall name a specification within that organization and parameterName shall be a name defined by the specification. For DMTF defined parameters: orgName shall be 'DMTF'; specName shall be the DSP name of the specification defining the parameter; and specVersion shall have the form M.N.E where M is the major version number, N is the minor version number, and E shall be the errata number. Each number shall not include leading zeros.
ParameterTypeuint16[]
ArrayTypestringIndexed
DescriptionstringEach entry specifies the type of the corresponding entry in the ParameterName property. If not specified, 3(string) is assumed.Note, ParameterConstraint entries can be used to specify valid value ranges.
ModelCorrespondencestringCIM_LaunchInContextSAP.ParameterName
ValueMapstring2, 3, 4, 5, 6, .., 0x8000..0xFFFF
ValuesstringInteger, String, Boolean, Real, DateTime, DMTF Reserved, Vendor Specific
SupportedFeatureDescriptionstring[]
ArrayTypestringIndexed
DescriptionstringEach entry describes the corresponding feature named in SupportedFeatureName. Each entry should describe the required parameters and related information used to select the feature when the service is launched.
ModelCorrespondencestringCIM_LaunchInContextSAP.SupportedFeatureName
SupportedFeatureNamestring[]
ArrayTypestringIndexed
DescriptionstringEach entry names a feature supported by the service addressed by AccessInfo. Feature names shall have the format orgName:specName:specVersion:featureName,where orgName shall be a trademarked, or otherwise owned name of the defining organization, specName together with specVersion shall name a specification within that organization and featureName shall be a name defined by the specification. For DMTF defined features: orgName shall be 'DMTF'; specName shall be the DSP name of a management profile; and specVersion shall have the form M.N.E where M is the major version number, N is the minor version number, and E shall be the errata number. Each number shall not include leading zeros.

Inherited Properties

NameData TypeClass Origin
CaptionstringCIM_ManagedElement
CommunicationStatusuint16CIM_ManagedSystemElement
CreationClassNamestringCIM_ServiceAccessPoint
DescriptionstringCIM_ManagedElement
DetailedStatusuint16CIM_ManagedSystemElement
ElementNamestringCIM_ManagedElement
EnabledDefaultuint16CIM_EnabledLogicalElement
EnabledStateuint16CIM_EnabledLogicalElement
Generationuint64CIM_ManagedElement
HealthStateuint16CIM_ManagedSystemElement
InstallDatedatetimeCIM_ManagedSystemElement
InstanceIDstringCIM_ManagedElement
NamestringCIM_ServiceAccessPoint
OperatingStatusuint16CIM_ManagedSystemElement
OtherAccessContextstringCIM_RemoteServiceAccessPoint
OtherEnabledStatestringCIM_EnabledLogicalElement
OtherInfoFormatDescriptionstringCIM_RemoteServiceAccessPoint
PrimaryStatusuint16CIM_ManagedSystemElement
RequestedStateuint16CIM_EnabledLogicalElement
StatusstringCIM_ManagedSystemElement
SystemCreationClassNamestringCIM_ServiceAccessPoint
SystemNamestringCIM_ServiceAccessPoint
TimeOfLastStateChangedatetimeCIM_EnabledLogicalElement
TransitioningToStateuint16CIM_EnabledLogicalElement
AvailableRequestedStatesuint16[]CIM_EnabledLogicalElement
OperationalStatusuint16[]CIM_ManagedSystemElement
StatusDescriptionsstring[]CIM_ManagedSystemElement

Class Methods

Local Class Methods

GetDerivedParametersForElement (uint32)

Method Qualifiers (GetDerivedParametersForElement)

NameData TypeValue
DescriptionstringThis method evaluates the parameters in the context of a specified instance referenced by ManagedElement. For each parameter entry containing an empty ParameterDerivation entry, the corresponding ParameterValue entry shall be an empty string. Otherwise, the value of the corresponding entry shall be the result of evaluating the derivation expression contained in the corresponding ParameterDerivation property. 0'Completed with No Error' is returned on success. 1'Not Supported' is returned if this method is not supported. 2'Unknown or Unspecified Error' is not expected 3'Failed' is not expected 4'Invalid Parameter' can happen if Self is not a well-formed association.
ValueMapstring0, 1, 2, 3, 4, .., 32768..65535
ValuesstringCompleted with No Error, Not Supported, Unknown or Unspecified Error, Failed, Invalid Parameter, DMTF Reserved, Vendor Specific

Method Parameters (GetDerivedParametersForElement)

NameTypeQualifiers
NameData TypeValue
ParameterValuestring[]
ArrayTypestringIndexed
DescriptionstringAn array of parameter values corresponding to the entries of the ParameterNames array
Inbooleanfalse
ModelCorrespondencestringCIM_LaunchInContextSAP.ParameterName
Outbooleantrue
Self REF CIM_ManagedElement
DescriptionstringThe ManagedElement used as 'self' in the derivation expressions contained in the ParameterDerivation array.
Inbooleantrue
Requiredbooleantrue

Inherited Class Methods

NameReturn TypeClass Origin
RequestStateChangeuint32CIM_EnabledLogicalElement