CIM_VirtualSystemMigrationSettingData class
Defines the settings for virtual system migration that is managed by an instance of the CIM_VirtualSystemMigrationService class. A migration implementation should inherit this class to add implementation specific migration options.
The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.
Syntax
[Experimental, Abstract, Version("2.20.0"), UMLPackagePath("CIM::System::Virtualization")]
class CIM_VirtualSystemMigrationSettingData : CIM_SettingData
{
string Caption;
string Description;
string InstanceID;
string ElementName;
uint16 MigrationType;
uint16 Priority;
uint16 Bandwidth;
string BandwidthUnit;
string OtherTransportType;
uint16 TransportType;
};
Members
The CIM_VirtualSystemMigrationSettingData class has these types of members:
Properties
The CIM_VirtualSystemMigrationSettingData class has these properties.
-
Bandwidth
-
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: Gauge, ModelCorrespondence ("CIM_VirtualSystemMigrationSettingData.BandwidthUnit")
The bandwidth assigned to or requested for a virtual system migration operation. "0" is default bandwidth for migration requests.
The Bandwidth and Priority properties may be used in conjunction. Migration processes that have the highest equal Priority values share the available bandwidth based on their requested bandwidth. If not all bandwidth is consumed by this set of processes, migration processes with the next lower equal Priority values share the remaining bandwidth. If more bandwidth remains, migration processes with the next lower equal Priority values are considered.
The unit used in Bandwidth property is specified by the value of the BandwidthUnit property.
If the value of the BandwidthUnit property is "percent", the following rules apply:
- The value of the Bandwidth property must be between "0" and "100", with higher values indicating a higher bandwidth.
- A value of "100" indicates all available bandwidth for performing virtual system migration operations.
- Values between "1" and "100" linearly correlate with the available bandwidth range. For example, a value of 50 requests half of the available bandwidth.
-
-
BandwidthUnit
-
-
Data type: string
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_VirtualSystemMigrationSettingData.Bandwidth"), IsPUnit
The unit used by the Bandwidth property. The value of this property should be a legal value of the Programmatic Units qualifier defined in Appendix C.1 of DSP0004 V2.4 or later.
Note
Profiles such as DMTF DSP1081 define how clients can discover the set of units supported by an implementation, and ranges and increments for values of the Bandwidth property.
-
-
Caption
-
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (64)
A short textual description of the object.
This property is inherited from CIM_ManagedElement.
-
-
Description
-
-
Data type: string
-
Access type: Read-only
A textual description of the object.
This property is inherited from CIM_ManagedElement.
-
-
ElementName
-
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Required
The user-friendly name for an instance of this class. In addition, the user-friendly name can be used as an index for a search or query. The name does not have to be unique within a namespace.
This property is inherited from CIM_SettingData.
-
-
InstanceID
-
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Key
Uniquely identifies an instance of this class within the scope of the containing namespace.
[!Important]
In order to ensure uniqueness within the namespace, the value of the InstanceID property should be constructed in the following pattern: OrgID:LocalID
- OrgID must include a copyrighted, trademarked or otherwise unique name that is owned by the business entity that defines the InstanceID property, or be a registered ID that is assigned by a recognized global authority.
- OrgID must not contain a colon. The first colon in InstanceID must be between the OrgID andLocalID.
- LocalID is chosen by the business entity and should not be re-used to identify different underlying real-world elements.
- If the above pattern is not used, the defining entity must assure that the resultant InstanceID value is not re-used across any InstanceID properties that are produced by this provider or other providers for this namespace.
- For DMTF defined instances, the pattern must be used with the OrgID set to "CIM".
This property is inherited from CIM_SettingData.
-
-
MigrationType
-
-
Data type: uint16
-
Access type: Read-only
The type of migration operation to perform.
-
-
Unknown (0)
-
Other (1)
-
Live (2)
-
Resume (3)
-
Restart (4)
OtherTransportType
-
Data type: string
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_VirtualSystemMigrationSettingData.TransportType")
The type of transport to apply if the value of TransportType is "1" (other).
Priority
-
Data type: uint16
-
Access type: Read-only
The relative migration importance that the virtual system migration implementation may use to order or assign preference among multiple pending migration requests. The lower the value, the higher the priority. "0" is default bandwidth for migration requests.
TransportType
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_VirtualSystemMigrationSettingData.OtherTransportType")
The type of transport to apply to a virtual system migration operation.
Unknown (0)
Other (1)
SSH (2)
TLS (3)
TLS Strict (4)
TCP (5)
IPC (6)
DMTF Reserved
Vendor Reserved
Requirements
| Minimum supported client |
None supported |
| Minimum supported server |
Windows Server 2016 |
| Namespace |
Root\HyperVCluster\v2 |
| MOF |
|
| DLL |
|