Msvm_RegisteredProfile class

Used to advertise implementation conformance to a profile.

The following syntax is simplified from MOF code and includes all inherited properties.

Syntax

class Msvm_RegisteredProfile : CIM_RegisteredProfile
{
  string Caption;
  string Description;
  string ElementName;
  string InstanceID;
  uint16 RegisteredOrganization;
  string OtherRegisteredOrganization;
  string RegisteredName;
  string RegisteredVersion;
  uint16 AdvertiseTypes[];
  string AdvertiseTypeDescriptions[];
};

Members

The Msvm_RegisteredProfile class has these types of members:

Properties

The Msvm_RegisteredProfile class has these properties.

AdvertiseTypeDescriptions

Data type: string array

Access type: Read-only

Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_RegisteredProfile.AdvertiseTypes")

A free-form string providing additional information related to the AdvertiseType. A description MUST be provided when the AdvertiseType is 1, "Other". An entry in this array corresponds to the entry in the AdvertiseTypes array at the same index. It is not expected that additional descriptions are needed if the Type is set to "Not Advertised" or "SLP". However, as the SLP template expands, or as other advertisement mechanisms are defined, support for additional descriptions may be needed. This array is defined to support this.

This property is inherited from CIM_RegisteredProfile.

AdvertiseTypes

Data type: uint16 array

Access type: Read-only

Qualifiers: Required, ArrayType ("Indexed"), ModelCorrespondence ("CIM_RegisteredProfile.AdvertiseTypeDescriptions")

This property signifies the advertisement for the profile information. It is used by the advertising services of the WBEM infrastructure to determine what should be advertised, via what mechanisms. The property is an array so that the profile MAY be advertised using several mechanisms. Note: If this property is null/uninitialized, this is equivalent to specifying the value 2, "Not Advertised".

The possible values are.

Other (1)

Not Advertised (2)

SLP (3)

This property is inherited from CIM_RegisteredProfile.

Caption

Data type: string

Access type: Read-only

Qualifiers: MaxLen (64)

The Caption property is a short textual description (one- line string) of the object.

This property is inherited from CIM_ManagedElement.

Description

Data type: string

Access type: Read-only

The Description property provides a textual description of the object.

This property is inherited from CIM_ManagedElement.

ElementName

Data type: string

Access type: Read-only

A user-friendly name for the object. This property allows each instance to define a user-friendly name IN ADDITION TO its key properties/identity data, and description information.

Note that ManagedSystemElement's Name property is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information MAY be present in both the Name and ElementName properties.

This property is inherited from CIM_ManagedElement.

InstanceID

Data type: string

Access type: Read-only

Qualifiers: Key

Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. In order to ensure uniqueness within the NameSpace, the value of InstanceID SHOULD be constructed using the following 'preferred' algorithm:

<OrgID>:<LocalID>

Where <OrgID> and <LocalID> are separated by a colon ':', and where <OrgID> MUST include a copyrighted, trademarked or otherwise unique name that is owned by the business entity creating/defining the InstanceID, or is a registered ID that is assigned to the business entity by a recognized global authority. (This is similar to the <Schema Name>_<Class Name> structure of Schema class names.) In addition, to ensure uniqueness, <OrgID> MUST NOT contain a colon (':'). When using this algorithm, the first colon to appear in InstanceID MUST appear between <OrgID> and <LocalID>.

<LocalID> is chosen by the organizational entity and SHOULD not be re-used to identify different underlying (real-world) elements. If the above 'preferred' algorithm is not used, the defining entity MUST assure that the resultant InstanceID is not re-used across any InstanceIDs produced by this or other providers for this instance's NameSpace.

For DMTF defined instances, the 'preferred' algorithm MUST be used with the <OrgID> set to 'CIM'.

This property is inherited from CIM_RegisteredProfile.

OtherRegisteredOrganization

Data type: string

Access type: Read-only

Qualifiers: MaxLen (256), ModelCorrespondence ("CIM_RegisteredProfile.RegisteredOrganization")

A free-form string providing a description of the organization. Only used when the RegisteredOrganization property is set to Other (1).

This property is inherited from CIM_RegisteredProfile.

RegisteredName

Data type: string

Access type: Read-only

Qualifiers: Required, MaxLen (256)

The name of this registered profile. Since multiple versions can exist for the same RegisteredName, the combination of RegisteredName, RegisteredOrganization, and RegisteredVersion MUST uniquely identify the registered profile within the scope of the organization.

This property is inherited from CIM_RegisteredProfile.

RegisteredOrganization

Data type: uint16

Access type: Read-only

Qualifiers: Required, ModelCorrespondence ("CIM_RegisteredProfile.OtherRegisteredOrganization")

The organization that defines this profile.

The possible values are.

Other (1)

DMTF (2)

CompTIA (3)

Consortium for Service Innovation (4)

FAST (5)

GGF (6)

INTAP (7)

itSMF (8)

NAC (9)

Northwest Energy Efficiency Alliance (10)

SNIA (11)

TM Forum (12)

The Open Group (13)

ANSI (14)

IEEE (15)

IETF (16)

INCITS (17)

ISO (18)

W3C (19)

This property is inherited from CIM_RegisteredProfile.

RegisteredVersion

Data type: string

Access type: Read-only

Qualifiers: Required

The version of this profile. The string representing the version MUST be in the form:

M + "." + N + "." + U

Where:

M - The major version (in numeric form) describing the profile's creation or last modification.

N - The minor version (in numeric form) describing the profile's creation or last modification.

U - The update (e.g. errata, patch, ..., in numeric form) describing the profile's creation or last modification.

This property is inherited from CIM_RegisteredProfile.

Requirements

Minimum supported client
None supported
Minimum supported server
Windows Server 2016
Namespace
Root\interop
MOF
WindowsHyperVCluster.V2.Mof
DLL
VMMS.exe

See also

CIM_RegisteredProfile