HardwareProfile [SPFSDK][VMMREF]

  • Article

 

Applies To: Windows Azure Pack

The HardwareProfile entity is used to specify hardware properties for a virtual machine or a virtual machine template.

Inheritance Hierarchy

VMM
  HardwareProfile

Entity Properties

For more information about how the properties of an entity interact with HTTP operations, see Entity Basics.

Name

Create (POST)

Read (GET)

Update (PUT)

Delete (DELETE)

Type

Nullable

Description

ID

-

Optional

Required

-

Edm.Guid

False

Key Property

The identifier of the hardware profile.

StampId

-

Optional

Required

-

Edm.Guid

False

Key Property

The identifier of the stamp.

AccessedTime

-

Optional

-

-

Edm.DateTime

True

The date and time that the VM was last accessed.

Accessibility

-

Optional

-

-

Edm.String

True

Specifies the VM’s accessibility as Public or Internal.

AddedTime

-

Optional

-

-

Edm.DateTime

True

Date and time the VM was added.

CPUCount

-

Optional

-

-

Edm.Byte

True

The number of CPUs of the VM.

CPUMax

-

Optional

-

-

Edm.Int32

True

The highest percentage of the total resources of a single CPU on the host that can be used by a specific VM at any given time.

CPUReserve

-

Optional

-

-

Edm.Int32

True

The minimum percentage of CPU capacity that is available to the VM.

CreationTime

-

Optional

-

-

Edm.DateTime

True

Date and time the VM was created.

Description

-

Optional

-

-

Edm.String

True

The description of the hardware profile.

DiskIO

-

Optional

-

-

Edm.Int32

True

The number of disk input/output operations per second (IOPS) on the host that the VM can use.

Enabled

-

Optional

-

-

Edm.Boolean

True

Indicates whether the VM can be started.

ExpectedCPUUtilization

-

Optional

-

-

Edm.Int32

True

The percentage of the host CPU capacity that the VM is expected to use.

Generation

-

Optional

-

-

Edm.Int32

True

Indicates whether the VM is a generation 1 or generation 2 VM.

GrantedToList

-

Optional

Required

-

Collection(UserAndRole)

False

Users and roles who have access to this hardware profile.

LimitCPUForMigration

-

Optional

-

-

Edm.Boolean

True

When True, limits the processor features to enable migration between hosts with different versions of the same processor. The processors must be from the same manufacturer.

LimitCPUFunctionality

-

Optional

-

-

Edm.Boolean

True

When True, enables running an older OS, such as Windows NT 4.0 on the VM.

Memory

-

Optional

-

-

Edm.Int32

True

The amount of RAM on the host that is allocated to a VM.

The default value is 512 MB.

ModifiedTime

-

Optional

-

-

Edm.DateTime

True

The date and time that the VM was last modified.

Name

-

Optional

-

-

Edm.String

True

The name of the hardware profile.

NetworkUtilization

-

Optional

-

-

Edm.Int32

True

The amount of bandwidth, in megabits per second (Mbps), on the host's network that can be used by the VM.

NumLockEnabled

-

Optional

-

-

Edm.Boolean

True

Enables the BIOS value for NumLock on a virtual machine.

Owner

-

Optional

-

-

UserAndRole

True

The owner of the VM in the form of a valid domain user account.

RelativeWeight

-

Optional

-

-

Edm.Int32

True

The amount of CPU resources on a host that this VM can use relative to other VMs on the same host.

A VM with a higher setting is allocated more CPU resources than a VM with a lower setting. The range of values varies with the type of host.

ShareSCSIBus

-

Optional

-

-

Edm.Boolean

True

Indicates whether the VM shares a SCSI Bus.

TotalVHDCapacity

-

Optional

-

-

Edm.Int64

True

The total virtual hard disk capacity.

UndoDisksEnabled

-

Optional

-

-

Edm.Boolean

True

Indicates whether the VM can undo any changes when shutting down.

Relationships

For more information about how the relationships of an entity are used, see Entity Basics.

Name

Relationship Type

From Property

To Entity

To Property

VirtualNetworkAdapters

Many

Not specified

VirtualNetworkAdapter [SPFSDK][VMMREF]

Not specified

VirtualSCSIAdapters

Many

Not specified

VirtualSCSIAdapter [SPFSDK][VMMREF]

Not specified

VirtualDVDDrives

Many

Not specified

VirtualDVDDrive [SPFSDK][VMMREF]

Not specified

OData Operations

None

Examples

See Also

Entities [SPFSDK][VMMREF]
HardwareProfiles Collection [SPFSDK][VMMREF]