How to: View or Modify a Virtual Machine or a Template

After you have worked with a virtual machine or template, you might want to update one or more of its properties. For example, if you have added software to the machine or changed some settings, you might want to revise the name or the description of the machine to let other users know about the changes.

To view or change the properties of a virtual machine or a template in an environment

  1. Open Microsoft Test Manager and connect to the team project.

  2. Open Lab Center.

  3. Click the Environment tab.

  4. Click the environment that the machine or template is in.

  5. Click Open.

  6. To view or change the name or the role, click Machines, and then click the appropriate edit box.

  7. To view or change the hardware profile, the OS profile, or the machine tags, click Machine properties, and then click the appropriate tab.

  8. If you have opened the wizard just to view the properties of the virtual machine or the template, close the wizard by clicking Cancel. If you have made changes and want to save the changes, click Finish.

To view or change the properties of a virtual machine or a template stored in the library

  1. Open Microsoft Test Manager and connect to the team project.

  2. Open Lab Center.

  3. Click the Library tab.

  4. Click the Virtual Machines and Templates sub-tab.

  5. Click the virtual machine or the template from the list.

  6. Click Open

  7. To view or change the name, the description, or the default role, click Name and machine step, and then click the appropriate edit box.

  8. To view or change the hardware profile, the OS profile, or the machine tags, click the Machine properties step, and then click the appropriate tab.

  9. If you have opened the wizard just to view the properties of the virtual machine or the template, close the wizard by clicking Cancel. If you have made changes and want to save the changes, click Finish.

Properties of Virtual Machines

Each virtual machine or template in a virtual environment has its own set of properties. If the environment is created from virtual machines or templates in the library, the values for some of these properties are inherited from that source. However, you can overwrite the inherited properties when you create the environment. For example, a virtual machine or a template stored in the library has a default role of Web Server associated with it. When that virtual machine or template is used to create an active environment, the corresponding copy of the virtual machine in the environment is given the role of Web Server. However, you can change the role to Server if you plan to install additional server components in the virtual machine copy. The default role of the original source virtual machine or template in the library remains unchanged.

The following table summarizes the properties of a virtual machine or a template and when that property is available to be viewed or changed. Not all properties can be edited in all states of the virtual machine or the template.

Property

Applies to

Computer name

  • Virtual machines in active environments.

Date created

  • Virtual machines and templates stored in the team project library.

Date modified

  • Virtual machines and templates stored in the team project library.

Default role

  • Virtual machines and templates in stored environments.

  • Virtual machines in active environments.

Description

  • Virtual machines and templates stored in the team project library.

Hardware profile

  • Memory

  • CPU

  • Total hard disk size

  • Virtual machines and templates in stored environments.

  • Virtual machines in active environments.

ID

  • Virtual machines and templates stored in the team project library.

Internal computer name

  • Virtual machines in active environments.

Last accessed time

  • Virtual machines and templates stored in the team project library.

Machine tags

  • Virtual machines and templates in stored environments.

  • Virtual machines in active environments.

Modified by

  • Virtual machines and templates stored in the team project library.

Name

  • Virtual machines and templates in stored environments.

  • Virtual machines in active environments.

OS profile

  • Computer name

  • Full name

  • Organization name

  • Administrator password

  • Product key

  • Time zone

  • Operating system

  • Domain or workgroup

  • One-time commands

  • Templates in stored environments.

Owner

  • Virtual machines and templates stored in the team project library.

Path

  • Virtual machines and templates stored in the team project library.

Project library share

  • Virtual machines and templates stored in the team project library.

SCVMM VM name

  • Virtual machines and templates in stored environments.

  • Virtual machines in active environments.

Status

  • Virtual machines and templates in stored environments.

  • Virtual machines in active environments.

Type

  • Virtual machines and templates in stored environments.

Computer name

This is the name of the computer assigned by the operating system in virtual machine. If the environment is not network isolated, it is made of the name that is returned when you type ‘hostname’ in a command shell inside the virtual machine plus the DNS suffix for the virtual machine. If the environment is network isolated, it is a unique name that is auto-generated by Lab Management and registered in DNS for the virtual machine.

Date created

This is the date and time when the virtual machine or the template was created in the team project library share. In the case when the virtual machine or the template is imported, this is the time when it was imported. In the case when the virtual machine or the template was created from an environment, this is the time when the creation started.

Date modified

This is the date and time when the virtual machine or template was edited by a user. The user changed one or more of the editable properties of the virtual machine or template.

Default role

Each virtual machine in an environment has one or more roles associated with it. Roles are used to identify the components of the application that are installed on a virtual machine in an environment. For example, if you are developing a three-tier application, you can associate a role of Web Server with the virtual machine that has the Web-tier in it, a role of Database Server with the virtual machine that has the data-tier in it, and a role of Web Client with the virtual machine that has the browser in it.

You can assign a default role to a virtual machine or a template; this will be used each time this virtual machine or template is used in an environment. Changing the role of a virtual machine or template changes the icon associated with it. The following roles are available for you to choose from:

  • Database Server: Indication that the virtual machine or the template has a database server installed in it.

  • Web Server: Indication that the virtual machine or the template has a Web server installed in it.

  • Server: Any other generic server, possibly with multiple server-side software components and roles.

  • Desktop Client: Indication that the virtual machine or the template has a client operating system installed on it and may be used as the client machine in a multi-machine environment.

  • Web Client: Indication that the virtual machine or the template has a client operating system along with a browser installed on it, and may be used as a Web client in a multi-machine environment.

  • Domain Controller: Indication that the virtual machine or template has a domain controller installed on it.

  • Your own role: If the previous roles do not suit your need, you can define your own roles for virtual machines or templates. To do this, open the virtual machine or template, and type the custom role string in Default role text box.

    Note

    These roles are just indications of what is installed in a virtual machine or in a template, or indications of the intended use when the environments were created. Lab Management does not automatically verify that the virtual machines or the templates have the necessary software, nor install the software automatically to fulfill these roles.

Description

This is a user-friendly annotation that describes the virtual machine or the template. You might include information such as the operating system, the software that has been installed, intended purpose, and information that you must have in order to connect to the virtual machine.

Hardware profile

These are the hardware properties of the virtual machine or the template. Three properties are currently available:

  • Memory: This is the amount of physical memory that should be reserved for the virtual machine when it is deployed on a Hyper-V host.

  • CPU: This is the type of CPU being emulated in the virtual machine.

  • Total hard disk size: This is total size taken by all the disks of the virtual machine or template. If the virtual machine consists of snapshots, the space that is required for storing the snapshots is considered also.

Choose a value for memory that meets the requirements of the applications that are installed on your virtual machines. Choosing a very low value causes the virtual machines to take a very long time to start or to do testing. It is recommended that you allocate at least 512 MB of memory for virtual machines and templates that run the Windows Server 2003 or Windows XP operating systems. Similarly, we recommend that you allocate at least 1024 MB of memory for virtual machines and templates that run Windows Server 2008, Vista, or newer operating systems. If you have several roles or applications installed in the virtual machines, increase this memory accordingly.

ID

A unique identifier assigned by Lab Management to track the virtual machine or the template. Use the ID in communications with the system administrator. The ID is also useful if you want to use the programming interface for Lab Management and build additional features that layer on top of Lab Management.

Internal computer name

This is applicable only for network isolated environments. It represents the computer name that is returned by the hostname command in the virtual machine.

Last accessed time

This is the date and time when the virtual machine or the template was last accessed. An access is any operation on or use of the virtual machine or template. In particular, this time stamp is updated whenever:

  • A virtual machine or template is edited.

  • An environment is created that uses the virtual machine or template.

The following operation does not update the last accessed time:

  • Opening the virtual machine or template to view (but not change) its properties.

The last accessed time is useful in managing the proliferation of virtual machines. You can write custom scripts to delete all virtual machines and templates that have not been accessed for a long time.

Machine tags

You can associate custom name-value properties for a virtual machine or a template. For example, you can use machine tags to associate each virtual machine or template with the following:

  • Patches and applications installed in the virtual machine.

  • Language or locale of the operating system.

  • Any additional information that is present in SCVMM but not exposed through Lab Management, for example, information about network cards on the virtual machine or the number of disks.

Modified by

This is the identity of the last person who edited the virtual machine or the template.

Name

This is the name of the virtual machine or the template in the environment. Two virtual machines or templates cannot have the same name in a given environment. This name could be different from the name of the source virtual machine or template that was used to compose the environment.

OS profile

This applies only to templates and captures how a template has to be customized when an environment is created from it. The process of customization is specific to the operating system that is located in the virtual machine. Consequently, not all properties described in the following list apply to all operating systems.

  • Computer name is the name to be assigned to each instance of a virtual machine created from the template. You may specify an asterisk (*) to indicate that the computer name has to be auto-generated. Therefore, if you use this template to create multiple environments, each instance of the virtual machine will get a unique name.

    Note

    The maximum length of a computer name is 15 characters. Most of the special characters are not allowed as part of a computer name.

  • Full name is used to customize each virtual machine with the name of the owner for that machine.

    Note

    Full name is a valid OS profile property only for Windows Server 2003 and XP operating systems.

  • Organization name is the name of your organization or department.

    Note

    Organization name is a valid OS profile property only for Windows Server 2003 and XP operating systems.

  • Administrator password is the password of the local administrator account on the virtual machine.

    Note

    The Administrator account is disabled on Windows Vista and Windows 7 operating systems. If your virtual machine or template has one of these operating systems, you must also specify the username that has to be added as an administrator.

    For Windows Server 2003 and Windows XP operating systems, you can specify the administrator password to be blank. To do this, type an asterisk (*) in the administrator password. For newer operating systems, leaving the Administrator password empty is an indication that the password should be blank.

  • Product key is a license key that is valid for the version of the operating system that is installed in the virtual machine or the template. If you intend to create multiple environments using this template, the product key you enter must let you do this. For example, use a Windows volume license key. Alternatively, you can have an empty value for the product key and customize it during environment creation.

    Important

    If the product key does not match the version of the operating system installed in the virtual machine template, you will not be able to successfully customize the virtual machine.

  • Time zone is used to customize the virtual machine with the selected information.

  • Operating system must match what is installed on the template. This information is used to identify how the customization must occur because the process varies depending on the version and flavor of the operating system.

    Note

    Make sure that the operating system is correct whenever you create or import a virtual machine template. Otherwise, the customization might fail.

  • Domain or workgroup specifies whether a virtual machine created from this template must be joined to a Workgroup or to an Active Directory domain. If using the workgroup option, you have to specify the name of the workgroup. Similarly, if using the domain option, you have to specify the name of an Active Directory domain and the credentials of a user who has the authority to create new machines in the domain.

    You must enter the user name as either <domain>\<username> (the down-level domain user name format) or the <username>@<company>.com (the user principals name format).

  • One-time commands are scripts that are executed on a virtual machine the first time a user logs into that virtual machine.

The following additional constraints apply when a stored environment with templates is being deployed to create an active environment.

  • Full name and Organization name cannot be empty for the following operating systems: Windows Server 2003 and Windows XP. For other operating systems, Full name and Organization name should not be specified.

  • Product key cannot be empty.

Owner

This is the identity of the person who imported or created the virtual machine or the template. The owner is the only person who can eventually delete the virtual machine or the template from team project library share. All the contributors in the team project can use, view, and update the virtual machine or the template.

Path

This is the location of virtual machine or the template in SCVMM. The path contains the name of the SCVMM library share and the name of the virtual machine or the template in SCVMM.

Project library share

This is the location of the virtual machine or template. The library of each team project may be organized into multiple project library shares. For more information about how to create team project library shares, see How to: Change the Library Share for Your Team Project Collections.

SCVMM VM name

Each virtual machine created and managed by Lab Management as part of an environment is referred through a unique name in Virtual Machine Manager. This name is auto-generated by Lab Management and has the form Lab_<GUID>, where GUID is a globally unique identifier. The virtual machine name is useful in relating a virtual machine that is part of an environment to its realization in Virtual Machine Manager. Use the virtual machine name in communications with the system administrator.

Status

This is the current state of the virtual machine or template. The following table describes the states supported by Lab Management.

Status

Applies to

Description

Stored

Virtual machines or templates in stored environments.

The virtual machine or template is stored in the library and is part of a stored environment.

Stopped

Virtual machines in active environments only.

The virtual machine has been powered off. It is not using CPU or memory resources on the hypervisor.

Running

Virtual machines in active environments only.

The virtual machine has been started.

Paused

Virtual machines in active environments only.

The virtual machine has been suspended. Its CPU execution has been frozen.

Saved

Virtual machines in active environments only.

The virtual machine has been saved through Virtual Machine Manager. Or, the virtual machine could not be started after it was restored to the snapshot.

Creating

Virtual machines or templates in stored environments, Virtual machines in active environments.

The virtual machine or template is being created and cannot be used until the creation is completed.

Starting

Virtual machines in active environments only.

The virtual machine is being started.

Stopping

Virtual machines in active environments only.

The virtual machine is being powered off or being shut down.

Pausing

Virtual machines in active environments only.

The virtual machine is being paused.

Saving

Virtual machines in active environments only.

The virtual machine is being saved. Saving stores the memory and CPU contents of the virtual machine to persistent storage on the host.

Deleting

Virtual machines or templates in stored environments, Virtual machines in active environments.

The virtual machine or template is being deleted.

Updating

Virtual machines or templates in stored environments, Virtual machines in active environments.

Properties of the virtual machine or template are being updated.

UpdateFailed

Virtual machines or templates in stored environments, Virtual machines in active environments.

Properties of the virtual machine or the template could not be updated.

CreatingSnapshot

Virtual machines in active environments only.

A new snapshot is being created on the virtual machine.

DiscardingSnapshot

Virtual machines in active environments only.

A snapshot is being deleted from the virtual machine.

RestoringSnapshot

Virtual machines in active environments only.

The virtual machine is being restored to an earlier snapshot.

UnderMigration

Virtual machines or templates in stored environments, Virtual machines in active environments

The system administrator is migrating the virtual machine or the template from its current location to another library server or to a host group by using Virtual Machine Manager.

CreateFailed

Virtual machines or templates in stored environments, Virtual machines in active environments.

Creation of the virtual machine or the template has failed. The only action available is to delete the virtual machine or the template and try to create it again.

CheckpointActionFailed

Virtual machines in active environments only.

A snapshot operation performed on the virtual machine failed.

Missing

Virtual machines or templates in stored environments, Virtual machines in active environments.

The virtual machine or the template has been deleted by the system administrator who is using Virtual Machine Manager or another tool. Alternatively, the system administrator has used Virtual Machine Manager to deploy the virtual machine or the template from its current location to a host group, possibly for patching.

HostNotResponding

Virtual machines in active environments.

The host on which the virtual machine is deployed is not reachable. Or the Virtual Machine Manager agent running on the host is unavailable.

MigrationFailed

Virtual machines or templates in stored environments, Virtual machines in active environments.

An attempt to migrate the virtual machine or the template by the system administrator has failed. The virtual machine or the template has been left in an unusable state. Only the system administrator can fix this.

CustomizationFailed

Virtual machines in active environments.

The customization of the virtual machine failed during creation. This can occur when one of the customization parameters specified through OS profile is incorrect.

IncompleteVMConfig

Virtual machines or templates in stored environments, Virtual machines in active environments.

One or more files that are required by the virtual machine or template are missing or deleted.

Unsupported

Virtual machines in active environments.

The virtual machine is in a state that is unrecognized by Lab Management.

Type

Type indicates whether this is a virtual machine or a virtual machine template.

See Also

Concepts

Creating Virtual Environments