VirtualMachines

System Center
 

Updated: June 27, 2017

Applies To: System Center 2016 - Service Provider Foundation, System Center Technical Preview

Reads, creates, updates, and deletes virtual machines in Virtual Machine Manager (VMM). From this collection you can change the state of a virtual machine.

GETPOSTPUTDELETE
YesYesYesYes

GET

Gets all virtual machines. This GET operation is further restricted by the available properties that you can add.

If you supply the ID property, the virtual machine with that identifier is returned.

If you supply the Name property, the virtual machine with that name is returned.

If you supply only the StampId property, all virtual machines that are assigned to the stamp are returned.

Entity Properties

NameTypeMandatoryDescription
StampIdEdm.GuidNoThe identifier of the stamp to restrict the query to
IDEdm.GuidNoThe identifier of the virtual machine
NameEdm.StringNoThe name of the virtual machine

POST

Creates a new virtual machine from either the specified virtual machine template or virtual hard disk.

Entity Properties

NameTypeMandatoryDescription
StampIdEdm.GuidYesThe identifier of the stamp to restrict the query to
NameEdm.StringYesThe name of the virtual machine
CloudIdEdm.GuidYesThe identifier of the cloud that this virtual machine will be associated with
VMTemplateIdEdm.GuidNoThe identifier of the template to create the virtual machine from
VirtualHardDiskIdEdm.GuidNoThe identifier of the virtual hard disk to create the virtual machine from
HardwareProfileIdEdm.GuidNoThe identifier of the hardware profile for this virtual machine
DescriptionEdm.StringNoThe description of the virtual machine
CostCenterEdm.StringNoThe cost center that this virtual machine is grouped with
TagEdm.StringNoA user-defined data field
ComputerNameEdm.StringNoThe name of the computer that this virtual machine represents
BlockDynamicOptimizationEdm.BooleanNoIndicates whether dynamic optimization is blocked for this virtual machine
CPULimitForMigrationEdm.BooleanNoWhen the value of this property is true, it limits processor features for the specified virtual machine to enable migration to a physical computer that has a different version of the same processor as the source computer. VMM does not support the migration of virtual machines between physical computers that have processors from different manufacturers.
CPULimitFunctionalityEdm.BooleanNoEnables running an older operating system (such as Windows NT 4.0) on a virtual machine that is deployed on a Hyper-V host or on a VMware ESX host by providing limited CPU functionality for the virtual machine.
CPURelativeWeightEdm.Int32NoSpecifies the amount of CPU resources on a host that this virtual machine can use in relation to other virtual machines on the same host. A virtual machine with a higher setting is allocated more CPU resources than a virtual machine with a lower setting.
DelayStartSecondsEdm.Int32NoSpecifies the number of seconds to wait after the virtualization service starts before automatically starting a virtual machine. This delay is used to stagger the startup time of multiple virtual machines to help reduce the demand on the physical computer’s resources. A typical setting might be 30 to 60 seconds.
DomainEdm.StringNoSpecifies a fully qualified domain name (FQDN) for an Active Directory domain.
DynamicMemoryBufferPercentageEdm.Int32NoSpecifies the percentage of memory above a virtual machine’s current memory allocation which the host should try to reserve as a buffer. The default value is 20.
DynamicMemoryEnabledEdm.BooleanNoWhen the value of this property is true, it enables dynamic memory for virtual machines. You can enable dynamic memory directly on a virtual machine or on a template or hardware profile that will be used to create virtual machines. The default value is false.
DynamicMemoryMaximumMBEdm.Int32NoSpecifies the maximum amount of memory that can be allocated to a virtual machine if dynamic memory is enabled. The default value is 65536.
FullNameEdm.StringNoThe name of the person that this virtual machine is registered to
MemoryEdm.Int32NoSpecifies, in megabytes (MB), the amount of random access memory (RAM) on the host that is allocated to a virtual machine. The default value is 512 MB. For a virtual machine on which dynamic memory is enabled (on a host running Windows Server 2008 R2 Service Pack 1 (SP1) or Windows Server 2012), this property represents the startup value.
MemoryWeightEdm.Int32NoIndicates the priority in allocating memory to a virtual machine, in relation to other virtual machines on the same host. A virtual machine with a higher setting is allocated more memory resources than a virtual machine with a lower setting.
OrganizationNameEdm.StringNoSpecifies the name of the organization for the person in whose name this virtual machine is registered.
StartActionEdm.StringNoSpecifies the behavior of a virtual machine when the virtualization service (Hyper-V, VMware, or XenServer) starts. Valid values are AlwaysAutoTurnOnVM, NeverAutoTurnOnVM, and TurnOnVMIfRunningWhenVSStopped.
StartVMEdm.BooleanNoSpecifies that the virtual machine starts when it arrives at the destination host.
StopActionEdm.StringNoSpecifies the behavior of the virtual machine when the virtualization service (Hyper-V, VMware, or XenServer) stops. Valid values are SaveVM, TurnOffVM, and ShutdownGuestOS.
CPUCountEdm.ByteNoSpecifies the number of CPUs on a virtual machine, a hardware profile, or a template.
OwnerUserAndRoleNoSpecifies the user account of the owner of this virtual machine.
ProductKeyEdm.StringNoSpecifies a product key. The product key is a 25-digit number that identifies the product license. A product key can be used to register VMM or an operating system to be installed on a virtual machine or host.
WorkGroupEdm.StringNoSpecifies the name of the workgroup to which you want to join this virtual machine.
TimeZoneEdm.Int32NoSpecifies 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.
RunAsAccountUserNameEdm.StringNoSpecifies the user name of the RunAsAccount of the virtual machine.
UserNameEdm.StringNoThe user name of an account that has permissions to join the virtual machine to a domain
PasswordEdm.StringNoSpecifies the password that is associated with the UserName property.
LocalAdminRunAsAccountNameEdm.StringNoThe name of the Run As account
LocalAdminUserNameEdm.StringNoThe user account of the local administrator
LocalAdminPasswordEdm.StringNoSpecifies the password that is associated with the LocalAdminUserName property.
NewVirtualNetworkAdapterInputNewVMVirtualNetworkAdapterInput[]YesA collection of network adapter information.

 Collection may be empty.
LinuxAdministratorSSHKeyEdm.StringNoSpecifies the public key file for a Linux SSH Key.
LinuxDomainNameEdm.StringNoSpecifies an FQDN to be used in conjunction with Linux operating system specialization.

PUT

Updates an existing virtual machine.

Entity Properties

NameTypeMandatoryDescription
StampIdEdm.GuidYesThe identifier of the stamp to restrict the query to
IDEdm.GuidYesThe identifier of the virtual machine to update
CostCenterEdm.StringNoThe cost center that this virtual machine is grouped with
CPUCountEdm.ByteNoSpecifies the number of CPUs on a virtual machine, on a hardware profile, or on a template.
CPUMaxEdm.Int32NoSpecifies the highest percentage of the total resources of a single CPU on the host that can be used by this virtual machine at any given time. A value of 80 represents 80 percent.
CPUReserveEdm.Int32NoSpecifies the minimum percentage of the resources of a single CPU on the host to allocate to this virtual machine. The percentage of CPU capacity that is available to the virtual machine is never less than this percentage.
DelayStartSecondsEdm.Int32NoSpecifies the number of seconds to wait after the virtualization service starts before automatically starting a virtual machine. This delay is used to stagger the startup time of multiple virtual machines to help reduce the demand on the physical computer’s resources. A typical setting might be 30 to 60 seconds.
DeployPathEdm.StringNoSpecifies the path to use when deploying a stored virtual machine.
DiskIOEdm.Int32NoSpecifies the number of disk input/output operations per second (IOPS) on the host that can be used by this virtual machine.
DismissEdm.BooleanNoWhen the value of this property is true, it dismisses the last error on the virtual machine object.
VMNetworkAssignmentsVMNetworkAssignments[]YesSpecifies the assigned network adapters and network pairs for this virtual machine.

 Collection may be empty.
NameEdm.StringNoThe name of the virtual machine
NetworkUtilizationEdm.Int32NoSpecifies, in megabits per second (Mbps), the amount of bandwidth on the host's network that can be used by this virtual machine.
OwnerUserAndRoleNoSpecifies the user account of the owner of this virtual machine.
GrantedToListUserAndRole[]YesThe collection of user roles that have access to this virtual machine.

 Collection may be empty.
TagEdm.StringNoA user-defined data field
OperationEdm.StringNoControls the virtual machine. Valid values are:

- Start
- Stop
- SaveState
- DiscardSavedState
- Suspend
- Shutdown
- Resume
- Repair
- Refresh
- Reset
- Store
- Deploy
HighlyAvailableEdm.BooleanNoSpecifies that a virtual machine will be placed on a Hyper-V host that is part of a host cluster.
MemoryEdm.Int32NoSpecifies, in MB, the amount of RAM on the host that is allocated to a virtual machine. The default value is 512 MB. For a virtual machine on which dynamic memory is enabled (on a host running Windows Server 2008 R2 SP1 or Windows Server 2012), this property represents the startup value.
NumLockEdm.BooleanNoEnables the BIOS value for NumLock on a virtual machine (or on a template or hardware profile that is used to create virtual machines) on a Hyper-V host. This parameter does not apply to virtual machines on VMware ESX hosts or on Citrix XenServer hosts.
RetryEdm.BooleanNoWhen the value of this property is set to true, it retries the most recently failed job.
DescriptionEdm.StringNoThe description of the virtual machine
SharePathEdm.StringNoThe Universal Naming Convention (UNC) path to a valid library share on an existing library server
StartActionEdm.StringNoSpecifies the behavior of a virtual machine when the virtualization service (Hyper-V, VMware, or XenServer) starts. Valid values are AlwaysAutoTurnOnVM, NeverAutoTurnOnVM, and TurnOnVMIfRunningWhenVSStopped.
StartVMEdm.BooleanNoSpecifies that the virtual machine starts when it arrives at the destination host.
StopActionEdm.StringNoSpecifies the behavior of the virtual machine when the virtualization service (Hyper-V, VMware, or XenServer) stops. Valid values are SaveVM, TurnOffVM, and ShutdownGuestOS.
UndoEdm.BooleanNoIf the value of this property is set to true, it reverses any changes that are made to this virtual machine. This property is available only when the most recent job has failed.
VMHostNameEdm.StringNoThe name of the host virtual machine
CapabilityProfileEdm.StringNoSpecifies the capability profile.

DELETE

Deletes an existing virtual machine.

Entity Properties

NameTypeMandatoryDescription
StampIdEdm.GuidYesThe identifier of the stamp to restrict the query to
IDEdm.GuidYesThe identifier of the virtual machine to delete

VMM Collections Reference

Show: