CIM_VirtualSystemMigrationSettingData class

Defines the settings for virtual system migration that is managed by an instance of the CIM_VirtualSystemMigrationService class.

Syntax

[Experimental, Abstract, Version("2.20.0"), UMLPackagePath("CIM::System::Virtualization"), AMENDMENT]
class CIM_VirtualSystemMigrationSettingData : CIM_SettingData
{
  uint16 MigrationType;
  uint16 Priority;
  uint16 Bandwidth;
  string BandwidthUnit;
  string OtherTransportType;
  uint16 TransportType;
};

Members

The CIM_VirtualSystemMigrationSettingData class has these types of members:

• Properties

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.

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 (32768..)

Requirements

Requirement	Value
Minimum supported client	Windows 8
Minimum supported server	Windows Server 2012
Namespace	Root\virtualization\v2
MOF	WindowsVirtualization.V2.mof
DLL	Vmms.exe

See also

CIM_SettingData