VMTemplate [SPFSDK][VMMREF]
Applies To: Windows Azure Pack
The VMTemplate entity represents a virtual machine template in Virtual Machine Manager (VMM).
VMM
VMTemplate
For more information about how the properties of an entity interact with HTTP operations, see Entity Basics.
Name | Create (PUT) | Read (GET) | Update (POST) | Delete (DELETE) | Type | Nullable | Description |
|---|---|---|---|---|---|---|---|
ID | - | Optional | Required | Required | Edm.Guid | False | Key Property The identifier of the entity. |
StampId | - | Optional | Required | Required | Edm.Guid | False | Key Property The identifier of the stamp that restricts the query. |
AccessedTime | - | Optional | - | - | Edm.DateTime | True | When the template was accessed. |
Accessibility | - | Optional | - | - | Edm.String | True | Indicates that this VM template is available for use (public) or is an internal VM template.
|
AddedTime | - | Optional | - | - | Edm.DateTime | True | When the template was added. |
Admin | - | Optional | - | - | Edm.String | True | Not used. |
AdminPasswordHasValue | - | Optional | - | - | Edm.Boolean | True | When True, indicates that the admin password for the VM template has a value. |
ApplicationProfileId | - | Optional | - | - | Edm.Guid | True | The identifier of the application host. |
AutoLogonCount | - | Optional | - | - | Edm.Int32 | True | The auto logon count provided by the VM template. |
BootOrder | - | Optional | - | - | Collection(Edm.String) | False | The order of devices that a virtual machine uses to start up.
|
CapabilityProfile | - | Optional | - | - | Edm.String | True | The associated capability profile. |
CloudID | - | Optional | - | - | Edm.Guid | True | The identifier of the associated cloud. |
ComputerName | - | Optional | - | - | Edm.String | True | The name of the computer that this VM template represents. |
CostCenter | - | Optional | - | - | Edm.String | True | The cost center that a VM is grouped with. |
CPUCount | - | Optional | - | - | Edm.Byte | True | The number of CPUs on a virtual machine. |
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 virtual machine. |
CPUReserve | - | Optional | - | - | Edm.Int32 | True | The minimum percentage of the total resources of a single CPU on the host that can be used by a virtual machine. |
CPUType | - | Optional | - | - | Edm.String | True | The type of CPU for a virtual machine. |
CreationTime | - | Optional | - | - | Edm.DateTime | True | When the virtual machine was created. |
CustomProperties | - | Optional | - | - | Collection(Edm.String) | False | A collection of custom properties. |
Description | - | Optional | - | - | Edm.String | True | The description of the VM template. |
DiskIO | - | Optional | - | - | Edm.Int32 | True | The number of disk I/O operations per second (IOPS) on the host that can be used by this virtual machine. |
DomainAdmin | - | Optional | - | - | Edm.String | True | The domain admin supplied by the VM template. |
DomainAdminPasswordHasValue | - | Optional | - | - | Edm.Boolean | True | When True, indicates that the domain admin account has a password value supplied. |
DomainAdminPasswordIsServiceSetting | - | Optional | - | - | Edm.Boolean | True | When True, indicates that the domain admin password is a service setting. |
DomainJoinOrganizationalUnit | - | Optional | - | - | Edm.String | True | The OU (organizational unit) of the domain that the virtual machine created by this template should become a part of. |
DynamicMemoryBufferPercentage | - | Optional | - | - | Edm.Int16 | True | The percentage of the current memory allocation which the host should try to reserve as a buffer. The default value is 20. |
DynamicMemoryEnabled | - | Optional | - | - | Edm.Boolean | True | Whether dynamic memory is enabled. The default is False. |
DynamicMemoryMaximumMB | - | Optional | - | - | Edm.Int32 | True | The maximum amount of memory that can be allocated if dynamic memory is enabled. The default value is 65536. |
DynamicMemoryPreferredBufferPercentage | - | Optional | - | - | Edm.Int16 | True | Not used. |
Enabled | - | Optional | - | - | Edm.Boolean | True | Enables an object when set to True, or disables an object when set to False. |
ExpectedCPUUtilization | - | Optional | - | - | Edm.Int32 | True | The amount of CPU utilization the virtual machine is expected to use. |
FullName | - | Optional | - | - | Edm.String | True | The name of the person this virtual machine is registered to. |
Generation | - | Optional | - | - | Edm.Int32 | True | The generation of virtual machine to create. |
GrantedToList | - | Optional | Required | - | Collection(UserAndRole [SPFSDK][VMMREF]) | False | The users or roles that can access this virtual machine template. |
GuiRunOnceCommands | - | Optional | - | - | Collection(Edm.String) | False | One or more commands to add to the [GuiRunOnce] section of an unattended answer file. |
HasVMAdditions | - | Optional | - | - | Edm.Boolean | True | When True, indicates that the virtual machine has the Virtual Machines Additions installed on it. |
IsCustomizable | - | Optional | - | - | Edm.Boolean | True | When False, indicates that this VM template does not use a guest operating system profile when the virtual machine instance is created. |
IsHighlyAvailable | - | Optional | - | - | Edm.Boolean | True | When True, indicates that the virtual machine is to be placed on a host cluster. |
IsTagEmpty | - | Optional | - | - | Edm.Boolean | True | When True, indicates that the Tag property is currently empty. |
IsTemporaryTemplate | - | Optional | - | - | Edm.Boolean | True | When True, indicates that this VM template is a temporary instance that was used to customize a deployment. |
JoinDomain | - | Optional | - | - | Edm.String | True | The domain to join when the virtual machine is created. |
JoinWorkgroup | - | Optional | - | - | Edm.String | True | The workgroup to join when the virtual machine is created. |
LibraryGroup | - | Optional | - | - | Edm.String | True | Not used. |
LimitCPUForMigration | - | Optional | - | - | Edm.Boolean | True | Limit processor features to enable migration |
LimitCPUFunctionality | - | Optional | - | - | Edm.Boolean | True | Limit CPU functions to enable running an older operating system |
Location | - | Optional | - | - | Edm.String | True | The file path of the virtual machine. |
Memory | - | Optional | - | - | Edm.Int32 | True | The allocated memory in megabytes or the startup memory if dynamic memory is enabled. |
MemoryWeight | - | Optional | - | - | Edm.Int16 | True | The priority in allocating memory to this virtual machine in relation to other virtual machines on the same host. |
MergeAnswerFile | - | Optional | - | - | Edm.Boolean | True | Not used. |
ModifiedTime | - | Optional | - | - | Edm.DateTime | True | When the VM template was last modified. |
Name | - | Optional | - | - | Edm.String | True | The name of the template. |
NetworkUtilization | - | Optional | - | - | Edm.Int32 | True | The amount of bandwidth on the host's network that can be used by a specific VM, in megabits per second (Mbps). |
NicCount | - | Optional | - | - | Edm.Int32 | True | The count of network adapters for this VM template. |
NumLockEnabled | - | Optional | - | - | Edm.Boolean | True | If True, enables the BIOS value for NumLock on a virtual machine. Not applicable on VMware ESX hosts or Citrix XenServer hosts. |
OperatingSystem | - | Optional | - | - | Edm.String | True | The operating system that the virtual machine will be using. |
OperatingSystemInstance | - | Optional | - | - | True | Describes the operating system of the virtual machine. | |
OrgName | - | Optional | - | - | Edm.String | True | The name of the organization for the person in whose name a virtual machine is registered. |
OSType | - | Optional | - | - | Edm.String | True | The type of operating system to be used by the virtual machine. |
Owner | - | Optional | - | - | UserAndRole | True | The user account of the owner of this virtual machine. |
ProductKeyHasValue | - | Optional | - | - | Edm.Boolean | True | When True, indicates that the product key to be used by the virtual machine has been provided. |
QuotaPoint | - | Optional | - | - | Edm.Int32 | True | How many qouta points this specific VM template is worth. |
RelativeWeight | - | Optional | - | - | Edm.Int32 | True | The relative weight of this virtual machine template compared to others. |
SANCopyCapable | - | Optional | - | - | Edm.Boolean | True | When True, indicates that this VM template can be copied through a SAN. |
SANStatus | - | Optional | - | - | Collection(Edm.String) | False | The current status of a SAN copy operation. |
ServerFeatures | - | Optional | - | - | Collection(Edm.String) | False | A collection of server features supported by the operating system. |
SharePath | - | Optional | - | - | Edm.String | True | The Universal Naming Convention (UNC) path to a valid library share on an existing library server. |
ShareSCSIBus | - | Optional | - | - | Edm.Boolean | True | When True, indicates that the SCSI bus used by this VM template is shared. |
SQLProfileId | - | Optional | - | - | Edm.Guid | True | The identifier of an associated SQL profile. |
Status | - | Optional | - | - | Edm.String | True | The status of the virtual machine. |
Tag | - | Optional | - | - | Edm.String | True | Extra information attached to this instance. |
TimeZone | - | Optional | - | - | Edm.Int32 | True | Specifies a number (an index) that identifies a geographical region that shares the same standard time. For a list of index numbers and corresponding time zones, see Microsoft Time Zone Index Values. |
TotalVHDCapacity | - | Optional | - | - | Edm.Int64 | True | The total capacity of all VHDs used by this template. |
UndoDisksEnabled | - | Optional | - | - | Edm.Boolean | True | When True, indicates that undo disks have been. |
UseHardwareAssistedVirtualization | - | Optional | - | - | Edm.Boolean | True | When True, indicates that the virtual machine created by this template will use hard assisted virtualization. |
VirtualFloppyDriveId | - | Optional | - | - | Edm.Guid | True | The identifier of the associated virtual floppy drive. |
VirtualHardDiskId | - | Optional | - | - | Edm.Guid | True | The identifier of the associated virtual hard disk. |
VirtualizationPlatform | - | Optional | - | - | Edm.String | True | The virtualization platform that will host the virtual machine. |
VMAddition | - | Optional | - | - | Edm.String | True | The version of the VM additions to be used by the virtual machine. |
VMId | - | Optional | - | - | Edm.Guid | True | The identifier of the virtual machine. |
VMTemplateId | - | Optional | - | - | Edm.Guid | True | The identifier of the VM template. |
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 | Not specified | |
VirtualSCSIAdapters | Many | Not specified | Not specified | |
VirtualHardDisks | Many | Not specified | Not specified | |
VirtualDVDDrives | Many | Not specified | Not specified | |
VirtualDiskDrives | Many | Not specified | Not specified |
This entity does not have any OData operations.