System�nter Virtual Machine Manager Scripting Guide

0x01 graphic

Microsoft® System Center Virtual Machine Manager

System Center Virtual Machine Manager Scripting Guide

Microsoft Corporation

Published: October 2007

Abstract

Microsoft System Center Virtual Machine Manager 2007 is a server application for managing a large number of virtual machines and the servers that support those virtual machines. The Virtual Machine Manager command shell is built on Microsoft Windows PowerShell, an administrator-focused interactive shell and scripting language that is integrated into the Windows platform. This guide provides sample scripts illustrating how you can use Windows PowerShell scripting for centralized management of your physical and virtual system infrastructure.

Disclaimer: The sample scripts in this guide are not supported under any Microsoft standard support program or service. The sample scripts are provided AS IS without warranty of any kind. Microsoft further disclaims all implied warranties including, without limitation, any implied warranties of merchantability or of fitness for a particular purpose. The entire risk arising out of the use or performance of the sample scripts and documentation remains with you. In no event shall Microsoft, its authors, or anyone else involved in the creation, production, or delivery of the scripts be liable for any damages whatsoever (including, without limitation, damages for loss of business profits, business interruption, loss of business information, or other pecuniary loss) arising out of the use of or inability to use the sample scripts or documentation, even if Microsoft has been advised of the possibility of such damages.

Information in this document, including URL and other Internet Web site references, is subject to change without notice. Unless otherwise noted, the companies, organizations, products, domain names, e-mail addresses, logos, people, places, and events depicted in examples herein are fictitious. No association with any real company, organization, product, domain name, e-mail address, logo, person, place, or event is intended or should be inferred. Complying with all applicable copyright laws is the responsibility of the user. Without limiting the rights under copyright, no part of this document may be reproduced, stored in or introduced into a retrieval system, or transmitted in any form or by any means (electronic, mechanical, photocopying, recording, or otherwise), or for any purpose, without the express written permission of Microsoft Corporation.

Microsoft may have patents, patent applications, trademarks, copyrights, or other intellectual property rights covering subject matter in this document. Except as expressly provided in any written license agreement from Microsoft, the furnishing of this document does not give you any license to these patents, trademarks, copyrights, or other intellectual property.

Microsoft, MS-DOS, Windows, Windows Server, Windows Vista, and Active Directory are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries.

All other trademarks are property of their respective owners.

Contents

Windows PowerShell Scripting in Virtual Machine Manager

Microsoft System Center Virtual Machine Manager 2007 is a server application that you can use to manage a large number of virtual machines. This guide provides sample Microsoft Windows PowerShell scripts for Virtual Machine Manager. The sample scripts illustrate how you can manage the servers, virtual machines, and resources in your virtual environment.

The Virtual Machine Manager command shell is built on Microsoft Windows PowerShell, an administrator-focused, interactive command-line shell and scripting language that is integrated into the Windows operating system. Windows PowerShell and Virtual Machine Manager each provide commands, called cmdlets, that you can use separately to perform simple administrative tasks or together with other cmdlets or command-line elements to perform complex tasks. You can use Virtual Machine Manager cmdlets, and scripts that are created by using these cmdlets, as an alternative to (or in addition to) using the Administrator Console for centralized management of your physical and virtual system infrastructure.

Virtual Machine Manager uses a Microsoft SQL Server 2005 database to store Virtual Machine Manager objects that represent all entities in a Virtual Machine Manager environment. At minimum, a Virtual Machine Manager environment includes the following services, which you can install on a single server or on separate servers:

 Virtual Machine Manager server. A computer running Windows Server 2003 Service Pack 1 (SP1) that stores or accesses the SQL Server database, which contains Virtual Machine Manager objects.

 Host server. A computer running Microsoft Virtual Server 2005 R2 that functions as a host on which to deploy virtual machines.

 Library server. A computer running Windows Server 2003 with SP1 that stores a variety of resources for your virtual machine environment. Resources include hardware profiles, operating-system profiles, virtual machine templates, virtual hard disks (.vhd files), virtual floppy disks (.vfd files), ISO images (.iso files), and scripts. In addition, you can store virtual machines in the library that, currently, you do not want to deploy on a host.

 Web server. Optionally, Virtual Machine Manager also supports a Web server that acts as a Self-Service Portal for users who are allowed to create or manage their own virtual machines, or do both.

In Virtual Machine Manager, you can create virtual machines from a variety of sources, including from an existing stopped virtual machine that is already deployed on a host, from a virtual machine that is stored in the library, from a virtual hard disk, or from a template. Virtual Machine Manager supports physical-to-virtual machine conversion (P2V conversion) and virtual-to-virtual machine conversion (V2V conversion).

Understanding and experimenting with the sample scripts that are included in this guide provides a starting point for developing Windows PowerShell scripts that you can customize for use in your own Virtual Machine Manager environment.

Getting Started with PowerShell Scripting for VMM

Microsoft System Center Virtual Machine Manager 2007 is a server application that you can use to manage a large number of virtual machines. The Virtual Machine Manager server product includes the Windows PowerShell - Virtual Machine Manager command shell. You can use this command shell to manage virtual machine hosts, library servers, virtual machines, and other Virtual Machine Manager components interactively at the command line or by using task-based scripting.

The Windows PowerShell - Virtual Machine Manager command shell is built on Microsoft Windows PowerShell. Windows PowerShell is an administrator-focused interactive command shell and scripting language that is integrated into the Windows operating system.

The Virtual Machine Manager command shell includes not only all the standard Windows PowerShell cmdlets, but also provides a comprehensive set of cmdlets that are designed specifically for use with Virtual Machine Manager. You can use standard Windows PowerShell cmdlets with Virtual Machine Manager to create scripts. Windows PowerShell, including the Virtual Machine Manager command shell, supports programming constructions such as variable assignment, looping, conditional statements, and flow-control.

The sample scripts in this guide illustrate how you can use Windows PowerShell for centralized management of your physical and virtual infrastructure when that infrastructure is managed by Virtual Machine Manager. Experimenting with these scripts can help you understand how to create scripts that are useful in your own environment.

This topic includes the following sections:

 How Windows PowerShell Supports Scripting

 How to Create Simple Scripts

 How to Convert an Existing Cmdlet Help Example to a Script

 How to Use the Profile.ps1 Script to Run Your Scripts Without Typing the Path

 How WMI Enables Cross-Product Scripting

If you are not familiar with the relationship of Windows PowerShell and Virtual Machine Manager, see the introductory information in "Appendix A: About Windows PowerShell for Virtual Machine Manager." If you are not familiar with how to use standard Windows PowerShell or Virtual Machine Manager cmdlets interactively at the command line, see "Appendix B: Command-Line Tutorial."

How Windows PowerShell Supports Scripting

The following sections explain how to enable scripting in Windows PowerShell, which script extensions are used in Windows PowerShell, and how to run a script.

How to Enable Windows PowerShell Scripting

When you first open the Windows PowerShell command shell on a computer, you cannot immediately run a Windows PowerShell script because the default security policy does not allow running scripts. The Windows PowerShell security policy for scripting, called an execution policy, lets you determine whether scripts can run in your environment and whether they must include a digital signature. None of the execution policies in Windows PowerShell allow you to run a script by double-clicking its icon because that is a high-risk method of running a script.

The four execution policies that govern scripting in Windows PowerShell are:

 Restricted (default). Permits interactive commands only (no scripts).

 AllSigned. Permits scripts but requires a digital signature from a trusted publisher on all scripts and configuration files, including scripts that you write on the local computer.

 RemoteSigned. Permits scripts but requires a digital signature from a trusted publisher on all scripts and configuration files that are downloaded from the Internet, including e-mail. A digital signature is not required for scripts that you create on the local computer.

 Unrestricted. Permits scripts, including unsigned scripts.

The default Windows PowerShell execution policy is the Restricted policy, so you cannot run Windows PowerShell scripts unless you change to a less restrictive execution policy. The "How to Create a Windows PowerShell 'Hello World' Script" section later in this topic includes a procedure that demonstrates how to enable scripting on your server.

In addition, the following table lists Windows PowerShell Help topics that explain what you need to know about Windows PowerShell execution policies and how to change your policy so that you can run scripts.

How to find out more about Windows PowerShell execution policies

Type at the command prompt:	Summary
Get-Help about_Signing	Describes Windows PowerShell execution policies and the varying levels of security that they provide.
Get-Help Get-ExecutionPolicy	Explains how to determine what your current scripting security policy is.
Get-Help Set-ExecutionPolicy	Explains how to change your current scripting security policy.

How to Identify Windows PowerShell Script Extensions

In Windows PowerShell, most script files have a .ps1 file name extension. However, three types of file name extensions are available for script files:

 .ps1 extension—Windows PowerShell shell script. The extension for standard Windows PowerShell scripts—including those that you write as you experiment with the scripts included in this guide.

 .psc1 extension—Windows PowerShell console file. A special type of script file that defines the configuration of a specific Windows PowerShell console. For example:

 "Microsoft System Center Virtual Machine Manager 2007\bin\cli.psc1" is the Windows PowerShell console file for Virtual Machine Manager.

 "Microsoft.EnterpriseManagement.OperationsManager.ClientShell.Console.psc1" is the Windows PowerShell console file for System Center Operations Manager.

For more information about Windows PowerShell consoles, type "Get-Help Export-Console" at the command prompt.

 .ps1xml extension—Windows PowerShell format and type definitions. These types of script files, in the Windows PowerShell home directory (at <C>:\WINDOWS\system32\windowspowershell\v1.0), provide a mechanism for extending the .NET Framework type system. For more information, type "Get-Help about_Types" at the command prompt.

How To Run a Windows PowerShell Script

You can use any of the following methods to run a Windows PowerShell script. In all cases you must indicate the full path with the name of the script even if you are working in the directory where the script is located.

 Use the Invoke-Expression cmdlet to run a script. For example:

Invoke-Expression C:\Scripts\<ScriptName>.ps1

 Use double quotation marks for any paths that include spaces. For example:

Invoke-Expression "C:\My Scripts\<ScriptName>.ps1"

 Use the ampersand to run a script. For example:

& C:\Scripts\<ScriptName>.ps1

 Specify only the path to the script. For example:

C:\Scripts\<ScriptName>.ps1

 Specify only the path to the script and omit the extension. For example:

C:\Scripts\<ScriptName>

 Use the dot backslash (.\) characters as a shorthand to indicate the local directory. For example:

.\ <ScriptName>.ps1

Important

You must indicate the full path with the name of the script even if you are working in the directory where the script is located—unless you create a special script called Profile.ps1 and configure it to enable you to run scripts without typing the path. For more information, see the "How to Enable Scripts to Run Without Typing the Path" section later in this topic.

How to Create Simple Scripts

The following sections show you how to create a "Hello World" script by using Windows PowerShell and how to list only Virtual Machine Manager cmdlets (that is, without also listing the core Windows PowerShell cmdlets). After that, the "How to Convert an Existing Cmdlet Help Example to a Script" section shows you how to create a script from any of the hundreds of examples available in the Virtual Machine Manager command-line Help.

How to Create a Windows PowerShell 'Hello World' Script

The following procedure shows you how to configure Windows PowerShell to allow scripting, which you must do before you can create the 'Hello World' script or any other script.

To enable scripting on your server

1. On a Virtual Machine Manager server on which the Administrator Console for Virtual Machine Manager is installed, click Start, point to All Programs, point to Microsoft System Center Virtual Machine Manager 2007, and then click Windows PowerShell - Virtual Machine Manager to open the command shell.

2. Type the following command to determine the current execution policy on the computer:

Get-ExecutionPolicy

3. Decide which execution policy you want to enable on the computer. This procedure assumes that:

 You are using a test server in a protected environment.

 Currently, the execution policy is Restricted.

 It is safe to change the execution policy to Unrestricted.

Caution

If you are working on a computer in your production environment, you might need to chose a more restrictive execution policy than Unrestricted. Refer to the information about the AllSigned and RemoteSigned execution policies described earlier in this topic.

4. Type the following command:

Set-ExecutionPolicy -ExecutionPolicy Unrestricted

5. Type the following command to clear the screen:

Clear-Host

The following procedure shows you how to create and run a simple 'Hello World' script.

To create the "Hello World" script

1. Type the following command to change to the directory where you want to save the script:

Set-Location 'My Documents\MyScripts'

Note

These examples assume that, when you open the Windows PowerShell window, the current location is <C:>\Documents and Settings\<YourAlias> and that you have created a folder called MyScripts under your My Documents folder.

2. Type the following command to create and name the script:

notepad Hello.ps1

3. When a dialog box appears asking whether you want to create a new file, click Yes.

4. When an empty Notepad window opens, confirm that Hello.ps1 appears in the Title bar.

5. Type the following series of comments and commands to create the script:

# Filename: Hello.ps1

Write-Host

Write-Host 'Hello World!'

Write-Host "Good-bye World! `n"

# end of script

When you use single quotes, the text appears exactly as you type it. When you use double quotes, Windows PowerShell can recognize and evaluate entities such as escape sequences or variables:

 Example of an escape sequence (used in the example script): The backtick character (`) followed by "n" is used to create a new line.

 Example of a variable (not used in this example script): An initial dollar sign followed by a name that you specify. A variable, such as $MyVM, is used to store an object; in this case, the object represents a virtual machine.

6. Save and close the Notepad file.

7. Run the script by typing the script name at the Windows PowerShell command prompt:

.\Hello

If the script does not work, verify that you are working in the same directory in which the script is stored and that you preceded the script name with a period and a backslash. Alternatively, in step 1, you can type the entire path to the script.

8. Review the output to verify that the script is displayed as expected.

How to List Only Virtual Machine Manager Cmdlets

The following procedure shows you how to create a Windows PowerShell script that lists only the Virtual Machine Manager cmdlets without also listing the core Windows PowerShell cmdlets.

To create a script that lists only Virtual Machine Manager cmdlets

1. Type a command to change to the directory where you want to save the script. For example:

Set-Location 'My Documents\MyScripts'

2. Type the following command to create and name the script:

notepad GetVMMCommand.ps1

3. When a dialog box appears asking whether you want to create a new file, click Yes.

4. Type the following series of comments and commands to create the script:

# Filename: GetVMMCommand.ps1

# GetVMMCommand.ps1 lists all Windows PowerShell cmdlets for

# Virtual Machine Manager but omits standard Windows PowerShell

# cmdlets.

Get-Command -PSSnapin VirtualMachineManagerSnapin

# end of script

Note

For more information about Windows PowerShell snap-ins, see the "How a Snap-in Provides Virtual Machine Manager Cmdlets" section in "Appendix A: About Windows PowerShell for Virtual Machine Manager" and see the "Sample Scripts for Managing Snap-ins" topic.

5. Save and close the Notepad file.

6. Run the script by typing the script name at the Windows PowerShell command prompt:

.\GetVMMCommand.ps1

7. Review the output to verify that the script displays the Virtual Machine Manager cmdlets.

How to Convert an Existing Cmdlet Help Example to a Script

The cmdlet Help that is built into the Windows PowerShell command shell for Virtual Machine Manager includes hundreds of examples of Virtual Machine Manager interactive commands that you can type at the command line. Many of these examples contain multiple lines of code and can be saved as a script. If you are not familiar with the cmdlet Help examples for Virtual Machine Manager, see "Appendix B: VMM Command-Line Tutorial."

How to Convert an Example for Restart-Job into a Script

The following procedure shows you how to take an existing example in the Virtual Machine Manager cmdlet Help and make it into a script.

To convert an existing cmdlet Help example into a script

1. Type a command to change to the directory where you want to save the script. For example:

Set-Location 'My Documents\MyScripts'

2. Type the following command to create and name a script—for this example, you convert an existing cmdlet example into a script that illustrates how to restart canceled Virtual Machine Manager jobs:

notepad RestartCancelledJobs.ps1

3. When a dialog box appears asking if you want to create a new file, click Yes.

4. At the top of the Notepad file, type:

# Filename: RestartCancelledJobs.ps1

5. Click Start, click All Programs, click Microsoft System Center Virtual Machine Manager 2007, and then click Windows PowerShell - Virtual Machine Manager to open the command shell.

6. At the command line, type the following command to display the cmdlet Help examples for the Restart-Job cmdlet:

Get-Help Restart-Job -example

7. Read the explanatory text for "EXAMPLE 1: Restart all jobs that were canceled on any virtual machine."

8. Copy the code for example 1 into the Notepad file:

a. Right-click inside the Windows PowerShell window, select Mark, highlight the code for example 3, and then press ENTER to copy the example into the buffer.

Note

If right-clicking the Windows PowerShell window does not display the Mark option, click the icon in the upper left-hand corner of the Windows PowerShell - Virtual Machine Manager title bar, click Edit, and then click Mark.

b. Click the Notepad file that you created in step 2 (named RestartCancelledJobs.ps1) to make it the active window, right-click the Notepad file, position the cursor under the filename comment (# Filename: RestartCancelledJobs.ps1), and then click Paste.

c. Confirm that the content of the Notepad file appears as follows:

# Filename: RestartCancelledJobs.ps1

PS C:\> Get-VMMServer -ComputerName "<VMMServer1>.<Contoso>.com"

PS C:\> Get-Job | where { $_.ResultName -eq "VM01" -and $_.Status -eq "Cancelled" } | Restart-Job

d. Remove any hard returns in the middle of a line and then delete the text that represents the prompt (PS C:\>, which indicates the start of each line of code), so that the content of the Notepad file now appears as follows:

# Filename: RestartCancelledJobs.ps1

Get-VMMServer -ComputerName "<VMMServer1>.<Contoso>.com"

Get-Job | where { $_.ResultName -eq "VM01" -and $_.Status -eq "Cancelled" } | Restart-Job

9. Substitute the names that you use in your environment for the example names that are used in the cmdlet Help. In this example:

 Substitute YourVMMServerName.YourDomainName.com for <VMMServer1>.<Contoso>.com

10. Save and close the Notepad file.

How to Use the Profile.ps1 Script to Run Your Scripts Without Typing the Path

If you want to be able to run your scripts without typing the script path each time, you can create a special Windows PowerShell script called Profile.ps1 that provides the path to the folder where you store your scripts. If Windows PowerShell scripting is enabled, the Profile.ps1 script runs whenever you open a new Windows PowerShell window.

To enable Windows PowerShell scripts to run without typing the path

1. In Windows Explorer, navigate to <C>:\Documents and Settings\<UserAlias>\My Documents\ folder, and then create two new folders:

<C>:\Documents and Settings\<UserAlias>\My Documents\MyScripts

<C>:\Documents and Settings\<UserAlias>\My Documents\Windows PowerShell

Note

You can create MyScripts in any folder that you want and you can name MyScripts any name that you want. However, you must create the Windows PowerShell folder under your My Documents folder, and you must include a space between Windows and PowerShell in the folder name.

2. Type the following command to create and name a script:

notepad Profile.ps1

3. When a dialog box appears asking whether you want to create a new file, click Yes.

4. When an empty Notepad window opens, confirm that Profile.ps1 appears in the Title bar.

5. Type the following comment and command to create the script:

# Filename: Profile.ps1

$env:path = $env:path + ";<C>:\Documents and Settings\<UserAlias>\My Documents\MyScripts"

# end of script

6. Save Profile.ps1 in the new Windows PowerShell folder:

<C>:\Documents and Settings\<UserAlias>\My Documents\Profile.ps1.

7. Open a new Windows PowerShell - Virtual Machine Manager command shell window.

8. Type the name of the Hello.ps1 script that you created earlier in this topic, without the path, and confirm that the script runs.

How to Provide User Credentials in a Script

To perform certain common actions in Virtual Machine Manager, such as adding new host servers on which to deploy virtual machines, you are required to provide user credentials. Credentials are the user name and password of an account that has permissions to perform the task you want to accomplish. You can provide credentials within a single script, or you can provide credentials globally so that the credential are available to all scripts that you run in the same session.

How to Store Credentials That a Specific Script Can Re-Use

When you type the following core Windows PowerShell cmdlet at the Windows PowerShell command prompt, Windows PowerShell prompts you to enter a user name and password:

Get-Credential

After you type a user name and password, Windows PowerShell stores these credentials in a Windows PowerShell credential object (PSCredential object).

If you want to avoid being prompted each time a script requires user credentials, you can use the following command to store the credentials securely in a variable that the script can then reuse:

$Credential = Get-Credential

In this case, you are prompted only once for the credentials. The following example, shows a script for adding hosts to Virtual Machine Manager and demonstrates how to use this command in a script.

Caution

It is possible to produce a PSCredential object programmatically through Windows PowerShell without requiring user interaction. However, this method requires that the user name and password appear in plain text in the script and is therefore not recommended.

How to Provide Credentials in a Script That Adds Hosts

The following procedure shows you how to create a Virtual Machine Manager script that lets you add a series of servers to Virtual Machine Manager as hosts for virtual machines. It also demonstrates how to store credentials for an account that has permissions to add hosts.

To create a script that adds a list of servers as hosts to Virtual Machine Manager

1. Before you run this script, make sure that the servers that you want to add as hosts meet the hardware and software requirements for Virtual Machine Manager described at http://go.microsoft.com/fwlink/?LinkId=69926.

2. Type a command to change to the directory where you want to save this script. For example:

Set-Location 'My Documents\MyScripts'

3. Type the following command to create and name a script:

notepad AddVMHostsList.ps1

4. When a dialog box appears asking if you want to create a new file, click Yes.

5. Type the following series of comments and commands to create the script:

Note

Be sure to substitute your actual server names and domain name for <VMHost01>.<Contoso>.com, <VMHost02>.<Contoso>.com, and <VMMServer1>.<Contoso>.com. In addition, be sure to type each command on a single line even though the longer commands are shown here on multiple lines for readability.

# Filename: AddVMHostsList.ps1

# Display a blank line.

Write-Host

# Send a message to the screen.

Write-Host -backgroundColor Red "When the Windows PowerShell Credential Request dialog box opens, type a user name and password for an account with permission to add a host."

# Store credentials with permissions to add hosts in a variable.

$Credential = Get-Credential

# Store host names in a variable.

$ServerNames = "<VMHost01>.<Contoso>.com", "<VMHost02>.<Contoso>.com"

# Add each server as a host.

foreach( $ServerName in $ServerNames ) { Add-VMHost -VMMServer <VMMServer1>.<Contoso>.com -ComputerName $ServerName -Credential $Credential }

# Display a blank line.

Write-Host

# end of script

How to Store Credentials That All Scripts in a Session Can Re-Use

If you run multiple scripts that require credentials, you can use the following command to store the PSCredential object securely in a global variable that all scripts can make use of:

$global:Credential = Get-Credential

In this case, you can enter the required credentials one time when you start a session, and all scripts that run during that session will use the $Credential variable.

How WMI Enables Cross-Product Scripting

Virtual Machine Manager uses Windows Management Instrumentation (WMI) for cross-product scripting. WMI is the Microsoft implementation of Web-Based Enterprise Management (WBEM), an industry-wide standard technology for accessing information about components of Windows-based computers in an enterprise environment.

A WMI interface provides programmatic access to a system, enabling users to write command-line administration scripts and tools. This enables network administrators to collect and set configuration details on a wide variety of hardware, operating system components and subsystems, and application software.

WMI does not consolidate the management data in a central location; System Center Configuration Manager 2007 performs this function. Configuration Manager provides inventory collection, software deployment, and diagnostic tools; automates software upgrades; enables remote problem solving; provides asset management information; and monitors software usage, computers, and networks. This facilitates the management of multiple servers as a single system to increase availability and manageability of data and applications.

For more information about how to use WMI, see "Accessing WMI from Windows PowerShell" (http://go.microsoft.com/fwlink/?LinkId=98347).

For More Information

For Windows PowerShell topics that are available on the Microsoft Web site:

 Windows PowerShell in the Microsoft Developers' Network (MSDN) Library at http://go.microsoft.com/fwlink/?LinkId=86262

 Scripting with Windows PowerShell at http://go.microsoft.com/fwlink/?LinkId=71134

 Using the Exchange Management Shell at http://go.microsoft.com/fwlink/?LinkId=79421

For Virtual Machine Manager topics that are available on the Microsoft Web site:

 Microsoft TechCenter Web site for Virtual Machine Manager at http://go.microsoft.com/fwlink/?LinkId=85920

 Access to Virtual Machine Manager Community at http://go.microsoft.com/fwlink/?LinkId=85918

 Sign up for the Virtual Machine Manager newsgroup at http://go.microsoft.com/fwlink/?LinkId=85919

For conceptual Help topics that are available with the Virtual Machine Manager cmdlet Help, type Get-Help about_<TopicName> to display the following topics:

 about_VMM

 about_VMM_Tutorial

 about_VMM_Scripting

For conceptual Help topics that are available with the standard Windows PowerShell cmdlet Help, type Get-Command about_*_to list the topics (many of which provide scripting-related information) and then type Get-Help about_<TopicName> to display information about those topics that you want to read:

 about_Alias

 about_Array

 about_Assignment_Operators

 about_Associative_Array

 about_Automatic_Variables

 about_Break

 about_Command_Syntax

 about_Comparison_Operators

 about_Continue

 about_Core_commands

 about_Environment_Variable

 about_Escape_Character

 about_Execution_Environment

 about_Filter

 about_Flow_Control

 about_For

 about_Foreach

 about_Function

 about_If

 about_Location

 about_Logical_Operator

 about_Method

 about_Object

 about_Operator

 about_Parameter

 about_Path_Syntax

 about_Pipeline

 about_Property

 about_Provider

 about_PSSnapins

 about_Regular_Expression

 about_Scope

 about_Script_Block

 about_Shell_Variable

 about_Special_Characters

 about_Switch

 about_System_State

 about_Types

 about_Where

 about_While

 about_Wildcard

 Get-ExecutionPolicy

 Get-Member

 Get-WMIObject

 Set-ExecutionPolicy

Sample Scripts for Managing Snap-ins

You can experiment with the Windows PowerShell scripts that are described in this topic to learn how to automate adding one or more Windows PowerShell snap-ins to the command shell.

If you open the Windows PowerShell - Virtual Machine Manager command shell, you can run both standard Windows PowerShell cmdlets and Virtual Machine Manager cmdlets. However, if you open the standard Windows PowerShell command shell, the Virtual Machine Manager cmdlets are not available unless you add the Virtual Machine Manager snap-in to the standard shell.

In some cases, you can add multiple snap-ins to the standard Windows PowerShell command shell if you want to be able to view and use cmdlets for two or more Microsoft products in the same shell. In other cases, adding multiple snap-ins to the standard Windows PowerShell command shell will not work. For example, if you want to access Virtual Machine Manager cmdlets in the same command shell as System Center Operations Manager, the best way to accomplish it is to add the path for the Windows PowerShell console file for Virtual Machine Manager to the Windows PowerShell console file for System Center Operations Manager.

AddVMMSnapin.ps1

You can use the following script to automate adding the Virtual Machine Manager snap-in to the standard Windows PowerShell command shell. Copy the following complete version of AddVMMSnapin.ps1 into a Notepad file and save it as AddVMMSnapin.ps1.

# Filename: AddVMMSnapin.ps1

# Description: Adds the Virtual Machine Manager snap-in to the

# standard Windows PowerShell command shell.

# For this script to run successfully, Virtual Machine

# Manager must be installed on the server on which you

# run this script.

# DISCLAIMER:

# script is made available to you without any express, implied or

# statutory warranty, not even the implied warranty of

# merchantability or fitness for a particular purpose, or the

# warranty of title or non-infringement. The entire risk of the

# use or the results from the use of this script remains with you.

######################################################################

# Add the VMM snap-in to the standard Windows PowerShell command shell.

######################################################################

Add-PSSnapin -name VirtualMachineManagerSnapIn

AddVMMExchSnapins.ps1

If you also want to run Windows PowerShell cmdlets for other Microsoft products, such as Microsoft Exchange Server, in the same command shell as the Virtual Machine Manager cmdlets, you must add the snap-ins for Virtual Machine Manager and the other products to the generic Windows PowerShell command shell.

Before You Start

You cannot add a snap-in that contains Windows PowerShell cmdlets for a particular Microsoft product to a server unless that product is installed on that server and a Windows PowerShell snap-in exists for that product.

To determine which Windows PowerShell snap-ins you can add on a server

1. On a server on which Virtual Machine Manager and Microsoft Exchange Server are installed, click Start, point to All Programs, point to Windows PowerShell 1.0, and then click Windows PowerShell.

Note

Do not click Start, point to All Programs, point to Microsoft System Center Virtual Machine Manager 2007, and then click Windows PowerShell - Virtual Machine Manager. You cannot add snap-ins for other Microsoft products to the Windows PowerShell - Virtual Machine Manager command shell.

2. To determine which snap-ins you can add to the standard Windows PowerShell console, type the following command at the command prompt:

Get-PSSnapin -Registered

This example assumes that Virtual Machine Manager and Microsoft Exchange Server are installed on the server, so the output should list a Windows PowerShell snap-in for each of these server products.

Add-VMMExchSnapins.ps1 - Complete Script

You can use the following script to automate adding the Virtual Machine Manager and Microsoft Exchange Server snap-ins to the standard Windows PowerShell command shell. Copy the following complete version of AddVMMExchSnapins.ps1 into a Notepad file and save it as AddVMMExchSnapins.ps1.

# Filename: AddVMMExchSnapins.ps1

# Description: Adds two snap-ins to the standard Windows PowerShell

# command shell: Virtual Machine Manager, and Microsoft

# Exchange Server. For this script to run

# successfully, both server products must be installed

# on the server on which you run this script.

# DISCLAIMER:

# script is made available to you without any express, implied or

# statutory warranty, not even the implied warranty of

# merchantability or fitness for a particular purpose, or the

# warranty of title or non-infringement. The entire risk of the

# use or the results from the use of this script remains with you.

######################################################################

# Add the VMM and Exchange snap-ins to the standard Windows

# PowerShell command shell.

######################################################################

Add-PSSnapIn -Name VirtualMachineManagerSnapIn, Microsoft.Exchange.Management.PowerShell.Admin

AddVMMCmdletsToOpsMgrConsole.ps1

If you want to make both Virtual Machine Manager cmdlets and System Center Operations Manager cmdlets available in the same Windows PowerShell window, you cannot use the Windows PowerShell cmdlet Add-PSSnapIn as described in the preceding section. If you did so, you would lose Operations Manager functionality for two reasons:

 The Operations Manager implementation of Windows PowerShell includes a provider in addition to cmdlets, but the Virtual Machine Manager implementation of Windows PowerShell includes only cmdlets.

 When you open Windows PowerShell from Operations Manager, Operations Manager loads its own Windows PowerShell console, and it also loads its own custom startup script.

You can use the following procedure to confirm that Operations Manager runs a custom startup script when you open the Operations Manager version of the command shell.

To confirm that Operations Manager runs a custom startup script when you open its console

1. On a server on which Operations Manager is installed, click Start, point to All Programs, point to System Center Operations Manager 2007, right-click Command Shell, and then click Properties.

2. View the contents of the Target field:

<C>:\WINDOWS\system32\windowspowershell\v1.0\powershell.exe -PSConsoleFile Microsoft.EnterpriseManagement.OperationsManager.ClientShell.Console.psc1 -NoExit .\Microsoft.EnterpriseManagement.OperationsManager.ClientShell.Startup.ps1

Notice that, after loading the Windows PowerShell console for Operations Manager, the command in the Target field also runs the custom script called Startup.ps1.

You can accommodate the Operations Manager provider and its startup script and you can also make Virtual Machine Manager cmdlets available by adding the Virtual Machine Manager cmdlets to the Operations Manager console. You can use the following procedure to make Machine Manager cmdlets available in the Operations Manager command shell.

To add Virtual Machine Manager cmdlets to the Operations Manager console

1. On a computer on which both Virtual Machine Manager and Operations Manager are installed, open Windows Explorer and navigate to:

C:\Program Files\System Center Operations Manager 2007

2. Open Microsoft.EnterpriseManagement.OperationsManager.ClientShell.Console.psc1 in Notepad.

3. Confirm that the original contents of the .psc1 console script file appear as follows:

<?xml version="1.0" encoding="utf-8"?>

</PSSnapIns>

</PSConsoleFile>

4. Add <PSSnapIn Name="VirtualMachineManagerSnapIn" />, which loads the Virtual Machine Manager cmdlets, to Microsoft.EnterpriseManagement.OperationsManager.ClientShell.Console.psc1 to , so that the Operations Manager . psc1 console script file appears as follows:

<?xml version="1.0" encoding="utf-8"?>

</PSSnapIns>

</PSConsoleFile>

5. Save and close Microsoft.EnterpriseManagement.OperationsManager.ClientShell.Console.psc1.

Sample Script for Upgrading Hosts and Library Servers

You can experiment with the Windows PowerShell script that is described in this topic to learn how to automate updating the agent software on hosts and library servers that are managed by Virtual Machine Manager.

UpgradeAgents.ps1

After you upgrade your Virtual Machine Manager server to a later version of the Virtual Machine Manager service, update the Virtual Machine Manager agent software that is installed on computers that are managed by that Virtual Machine Manager server to the current version of the agent software. You can use the UpgradeAgents.ps1 script to automate that update.

Managed computers on which you might need to update the agent software include:

 Host servers on which you deploy virtual machines.

 Library servers on which you store library resources.

How UpgradeAgents.ps1 Works

The UpgradeAgents.ps1 script performs the following tasks:

 Connects to the Virtual Machine Manager server and retrieves the object that represents the server from the Virtual Machine Manager database. Connecting to the Virtual Machine Manager server retrieves the server object from the Virtual Machine Manager database and gives you access to all other objects in the SQL Server database that stores all Virtual Machine Manager objects for as long as the connection lasts or until you close the command-shell window.

 Uses the Virtual Machine Manager cmdlet, Get-VMMManagedComputer, to get the objects that represent all computers managed by Virtual Machine Manager (that is, to retrieve from the Virtual Machine Manager database the objects for all virtual machine hosts and all library servers); uses the standard Windows PowerShell cmdlet, Where-Object, (whose alias is "where") to select from the set of all managed computers only objects for those managed computers whose agent software is not current; and stores the selected computer objects in variable $VMMManagedComputers.

 Uses the standard Windows PowerShell cmdlet, Get-Credential, to prompt you to provide credentials that have permissions to update computers that are managed by Virtual Machine Manager.

 Uses a ForLoop to perform the following tasks:

 Loops through each object in $VMMManagedComputer in turn.

 Uses the Virtual Machine Manager cmdlet, Update-VMMManagedComputer, to install updated agent software on each managed computer, by using the credentials you provided earlier for each update.

UpgradeAgents.ps1 - Complete Script

Copy the following complete version of UpgradeAgents.ps1 into a Notepad file and save it as UpgradeAgents.ps1:

# Filename: UpgradeAgents.ps1.ps1

# Description: Updates the System Center Virtual Machine Manager

# agent software on any managed computer (that is, any

# host or library server) that is running an earlier

# version of the agent software.

# DISCLAIMER:

# script is made available to you without any express, implied or

# statutory warranty, not even the implied warranty of

# merchantability or fitness for a particular purpose, or the

# warranty of title or non-infringement. The entire risk of the

# use or the results from the use of this script remains with you.

####################################################################

# Connect to the Virtual Machine Manager server.

####################################################################

# Substitute the name of your VMM server and domain in this command:

Get-VMMServer -ComputerName "VMMServer1.Contoso.com"

####################################################################

# Get the object that represents each managed computer which is

# not running the current version of the VMM agent software.

####################################################################

$VMMManagedComputers = Get-VMMManagedComputer | where {$_.VersionStateString -NE "Current"}

####################################################################

# When prompted, type the user name and password of an account

# with permissions to update both hosts and library servers.

####################################################################

$Creds = Get-Credential

####################################################################

# Loop through each managed computer that is not up-to-date

# and update its VMM agent software.

####################################################################

ForEach ($Computer in $VMMManagedComputers )

{

# Upgrade the agents On the managed computers

Update-VMMManagedComputer -Credential $Creds

}

Sample Script for Managing Hosts

You can experiment with the Windows PowerShell script in this topic to learn how to script adding to Virtual Machine Manager computers that are running Virtual Server but that are not currently managed by Virtual Machine Manager.

AddVSServerAsHost.ps1

You can use the AddVSServerAsHost.ps1 script to search Active Directory for servers that have Virtual Server 2005 R2 installed but are not currently managed by Virtual Machine Manager. You can use the script to add those servers as managed virtual machine hosts.

How AddVSServerAsHost.ps1 Works

The following sections explain each part of the script AddVSServerAsHost.ps1.

Connect to VMM Server

The first command in the script AddVSServerAsHost.ps1 connects to the Virtual Machine Manager server so that subsequent commands can access objects in the Virtual Machine Manager database.

####################################################################

# Connect to the Virtual Machine Manager server

####################################################################

# Substitute the name of your VMM server and domain in this command:

Get-VMMServer -ComputerName "VMMServer1.Contoso.com"

Define a Function That Returns the FQDN of a Computer

The next set of commands in the script AddVSServerAsHost.ps1 defines a function in which Windows PowerShell uses C# commands to return the fully qualified domain name (FQDN) of a computer by performing the following tasks:

 Retrieves the domain name and computer name of a computer from the Lightweight Directory Access Protocol (LDAP) string for that computer.

 Concatenates the domain name and computer name to return the computer's FQDN.

The script invokes the defined function later (in the ForEach loop) after first using an LDAP (Lightweight Directory Access Protocol) query to return from Active Directory objects that represent all computers on which Virtual Server 2005 R2 is installed.

LDAP, an industry standard that is implemented by both Windows operating systems and non-Windows operating systems, is the primary directory access protocol that Windows operating systems use to add, modify, and delete information that is stored in Active Directory and to query and retrieve data from Active Directory. For more information about LDAP, see "Lightweight Directory Access Protocol" at http://go.microsoft.com/fwlink/?LinkId=104719.

####################################################################

# Define a function that selects the FQDN of a computer from the

# LDAP string returned from Active Directory by the LDAP query.

# (The LDAP query occurs later in this script.)

####################################################################

function Get-FQDN

{

# Declare the parameter for the LDAP string.

Param( $LDAPString )

# Get the domain name from the LDAP string.

$Domain = $LDAPString.ToString().SubString( $LDAPString.ToString().IndexOf(",DC=") + 4 )

$Domain = $Domain.ToString().Replace(",DC=", ".")

# Get the computer name from the LDAP string.

$ComputerName = $LDAPString.Split(',')[1].Remove(0,3)

# Return the FQDN from the function.

Return $ComputerName + "." + $Domain

}

Define a Function That Adds a Computer to VMM as a Host

The next set of commands in the script AddVSServerAsHost.ps1 defines a function that adds a computer as a managed host to Virtual Machine Manager by performing the following tasks:

 Displays a message each time a host is added.

 Retrieves the object that represents the group to which the host will be added, and adds the host to that group.

 Enables Virtual Machine Remote Control (VMRC) and configures several VMRC settings: The script allows only one connection at a time to a virtual machine by disabling multiple VMRC connections; sets the VMRC port to 5900 (the default port); enables a VMRC timeout interval (the length of time a VMRC connection remains idle before it is automatically disconnected); and sets the VMRC timeout interval to 30 minutes.

Note

VMRC is a feature of Microsoft Virtual Server 2005 that lets a VMRC client connect to an instance of Virtual Server to access that server's virtual machines. VMRC enables users to access their virtual machines remotely.

The script will invoke the defined function later (in the ForEach loop), after it uses the Get-FQDN function to retrieve the FQDN of computers that are running Virtual Server and after it selects only those computers that are running Virtual Server and that are not already managed by Virtual Machine Manager.

####################################################################

# Define a function that adds a computer as a host to VMM

####################################################################

function Add-NewVMHost

{

# Declare the parameter for the name of the host.

param( $HostName )

# Display a message each time a host is added.

"Adding host '" + $HostName + "'..."

# Get the object that represents the host group in which you want

# to place a new host.

$HostGroup = Get-HostGroup -Name "All Hosts"

# Add the new host to the specified host group and configure VMRC.

Add-VMHost -ComputerName $HostName -VMHostGroup $HostGroup -VMRCEnabled $TRUE -VMRCMultipleConnectionsEnabled $FALSE -VMRCPort 5900 -VMRCTimeoutEnabled $TRUE -VMRCTimeoutMinutes 30

}

Identify Servers Running Virtual Server 2005 R2

The next set of commands in the script AddVSServerAsHost.ps1 uses an LDAP query to identify servers that are running Virtual Server 2005 R2 by performing the following tasks:

 Creates an object that represents the organizational unit (OU) container for all computers that are located in the Contoso.com domain, and stores the object in variable $Root. The name $Root is used to indicate that the root of the search to be performed is set at the OU in the directory hierarchy.

 Creates a directory search object that is used to search $Root for objects that represent computers on which the Virtual Server service is installed, and then stores the search object in $Searcher.

 Runs an LDAP query to find the object that represents each computer on which Virtual Server is installed and stores the returned objects as an object array in variable $Result.

The script loops through each object in $Result later (in the ForEach loop) to determine whether a given object is or is not already managed by Virtual Machine Manager.

####################################################################

# Use an LDAP query to get computers running Virtual Server 2005 R2.

####################################################################

# Create an object that represents the OU container for computers in

# the Contoso.com domain, and store the new object in variable $Root.

$Root = New-Object DirectoryServices.DirectoryEntry "LDAP://OU=Computers,DC=contoso,DC=com"

# Create a directory search object to search $Root for objects that

# represent computers on which Virtual Server is installed, and store

# the search object in variable $Searcher.

$Searcher = New-Object DirectoryServices.DirectorySearcher $Root, "(&(objectCategory=serviceConnectionPoint)(CN=MS Virtual Server))"

# Run the LDAP query and store the returned objects as an

# object array in variable $Result.

$Result = $Searcher.FindAll()

Add Non-VMM Computers Running Virtual Server to VMM

The last set of commands in the script AddVSServerAsHost.ps1 adds each computer to Virtual Machine Manager if it is running Virtual Server 2005 R2 but is not currently managed by Virtual Machine Manager by using a ForEach loop to perform the following tasks:

 Loops through each object in $Result (that is, each server running Virtual Server) in turn.

 Uses the Get-FQDN function that was defined earlier to get the FQDN of each computer in $Result.

 Uses the Virtual Machine Manager cmdlet Get-VMHost to determine whether a computer in $Result is already managed by Virtual Machine Manager.

 If a computer in $Result is not currently managed by Virtual Machine Manager, the script uses the Add-NewVMHost function that was defined earlier to add the computer to Virtual Machine Manager.

####################################################################

# Process each object in $Result (that is, each computer running

# Virtual Server) and add that computer to the VMM database if it

# has Virtual Server installed but is not yet a VMM host.

####################################################################

ForEach ($Object in $Result)

{

# Get the fully qualified domain name.

$FQDN = Get-FQDN( $Object.GetDirectoryEntry().DistinguishedName.ToString() )

# Determine whether the computer is already managed by VMM and,

# if not, add it to VMM as a managed host.

If(!(Get-VMHost | where {$_.Name -Eq $FQDN}))

{

# Else (if the computer is not a host), add it to VMM as a host

Add-NewVMHost $FQDN

}

AddVSServerAsHost.ps1 - Complete Script

Copy the following complete version of AddVSServerAsHost.ps1 into a Notepad file, and save it as AddVSServerAsHost.ps1.

# Filename: AddVSServerAsHost.ps1

# Description: Search Active Directory for servers on which

# Virtual Server 2005 R2 is installed that are

# not currently managed by System Center Virtual

# Machine Manager. Add those servers as hosts to

# Virtual Machine Manager.

# DISCLAIMER:

# script is made available to you without any express, implied or

# statutory warranty, not even the implied warranty of

# merchantability or fitness for a particular purpose, or the

# warranty of title or non-infringement. The entire risk of the

# use or the results from the use of this script remains with you.

####################################################################

# Connect to the Virtual Machine Manager server

####################################################################

# Substitute the name of your VMM server and domain in this command:

Get-VMMServer -ComputerName "VMMServer1.Contoso.com"

####################################################################

# Define a function that selects the FQDN of a computer from the

# LDAP string returned from Active Directory by the LDAP query.

# (The LDAP query occurs later in this script.)

####################################################################

function Get-FQDN

{

# Declare the parameter for the LDAP string.

Param( $LDAPString )

# Get the domain name from the LDAP string.

$Domain = $LDAPString.ToString().SubString( $LDAPString.ToString().IndexOf(",DC=") + 4 )

$Domain = $Domain.ToString().Replace(",DC=", ".")

# Get the computer name from the LDAP string.

$ComputerName = $LDAPString.Split(',')[1].Remove(0,3)

# Return the FQDN from the function.

Return $ComputerName + "." + $Domain

}

####################################################################

# Define a function that addS a computer as a host to VMM

####################################################################

function Add-NewVMHost

{

# Declare the parameter for the name of the host.

param( $HostName )

# Display a message each time a host is added.

"Adding host '" + $HostName + "'..."

# Get the object that represents the host group in which you want

# to place a new host.

$HostGroup = Get-HostGroup -Name "All Hosts"

# Add the new host to the specified host group and configure VMRC.

Add-VMHost -ComputerName $HostName -VMHostGroup $HostGroup -VMRCEnabled $TRUE -VMRCMultipleConnectionsEnabled $FALSE -VMRCPort 5900 -VMRCTimeoutEnabled $TRUE -VMRCTimeoutMinutes 30

}

####################################################################

# Use an LDAP query to get computers running Virtual Server 2005 R2.

####################################################################

# Create an object that represents the OU container for computers in

# the Contoso.com domain and store the new object in variable $Root.

$Root = New-Object DirectoryServices.DirectoryEntry "LDAP://OU=Computers,DC=contoso,DC=com"

# Create a directory search object to search $Root for objects that

# represent computers on which Virtual Server is installed, and store

# the search object in variable $Searcher.

$Searcher = New-Object DirectoryServices.DirectorySearcher $Root, "(&(objectCategory=serviceConnectionPoint)(CN=MS Virtual Server))"

# Run the LDAP query and then store the returned objects as an

# object array in variable $Result.

$Result = $Searcher.FindAll()

####################################################################

# Process each object in $Result (that is, each computer running

# Virtual Server) and add that computer to the VMM database if it

# has Virtual Server installed but is not yet a VMM host.

####################################################################

ForEach ($Object in $Result)

{

# Get the fully qualified domain name.

$FQDN = Get-FQDN( $Object.GetDirectoryEntry().DistinguishedName.ToString() )

# Determine whether the computer is already managed by VMM and,

# if not, add it to VMM as a managed host.

If(!(Get-VMHost | where {$_.Name -Eq $FQDN}))

{

# Else (if the computer is not a host), add it to VMM as a host

Add-NewVMHost $FQDN

}

QuickMigrate-VM.ps1

The QuickMigrate-VM.psi script quickly migrates a highly available virtual machine from its existing host to the best rated host that is part of the same host cluster.

The virtual machine must be configured as a highly available virtual machine (using Havm.vbs script) on Windows Server 2003 host cluster. The virtual machine must have its Custom7 property set to the name of the cluster resource group that it belongs to.

All the nodes of the Windows Server 2003 host cluster must be added as hosts in the Virtual Machine Manager 2007. All the clustered hosts must have their Custom7 property set to the name of the host cluster to which they belong.

QuickMigrate-VM.ps1 - Complete Script

# DISCLAIMER:

# script is made available to you without any express, implied or

# statutory warranty, not even the implied warranty of

# merchantability or fitness for a particular purpose, or the

# warranty of title or non-infringement. The entire risk of the

# use or the results from the use of this script remains with you.

##################################################################################

# Check usage

##################################################################################

param ($VMName, $VMMServerName)

if ($VMName -eq $null -or $VMMServerName -eq $null)

{

Write-Host -foregroundcolor DarkGray "`nUsage: QuickMigrate-VM -VMName <String> -VMMServerName <String>"

Write-Host -foregroundcolor DarkGray "`nQuickly migrates a highly available virtual machine from its existing"

Write-Host -foregroundcolor DarkGray "host to the best rated host that is part of the same host cluster."

Write-Host -foregroundcolor DarkGray "`nThe virtual machine must be configured as a highly available virtual"

Write-Host -foregroundcolor DarkGray "machine (using havm.vbs script) on Windows Server 2003 host cluster."

Write-Host -foregroundcolor DarkGray "The virtual machine must have its Custom7 property set to the name"

Write-Host -foregroundcolor DarkGray "of the cluster resoruce group that it belongs to."

Write-Host -foregroundcolor DarkGray "`nAll the nodes of the Windows Server 2003 host cluster must be added"

Write-Host -foregroundcolor DarkGray "as hosts in the Virtual Machine Manager 2007. All the clustered hosts"

Write-Host -foregroundcolor DarkGray "must have its Custom7 property set to the name of the host cluster"

Write-Host -foregroundcolor DarkGray "that they belong to."

Write-Host -foregroundcolor DarkGray "`nUser running the script must be VMM administrator as well as cluster"

Write-Host -foregroundcolor DarkGray "administrator."

Write-Host

return

}

##################################################################################

# Connect to Virtual Machine Manager server

##################################################################################

Write-Host "`nTrying to connect to Virtual Machine Manager server $VMMServerName. This may take some time..."

$VMMServer = Get-VMMServer -ComputerName $VMMServerName

if ($VMMServer -eq $null)

{

Write-Host " ERROR: Cannot connect to Virtual Machine Manager server $VMMServerName`n" -foregroundcolor Red

return

}

else

{

Write-Host " Done!`n" -foregroundcolor Yellow

}

##################################################################################

# Get cluster resource group name which is Custom7 property of virtual machine

##################################################################################

Write-Host "Trying to find virtual machine $VMName..."

$VM = Get-VM -Name $VMName

if ($VM -eq $null)

{

Write-Host " ERROR: Cannot find virtual machine $VMName in VMM server $VMMServerName`n" -foregroundcolor Red

return

}

else

{

Write-Host " Done!`n" -foregroundcolor Yellow

}

Write-Host "Trying to get cluster resource group name by reading Custom7 property of virtual machine $VMName..."

if ($VM.CustomProperties[6] -eq "")

{

Write-Host " ERROR: $VMName does not appear to be highly available virtual machine since its Custom7 property is blank`n" -foregroundcolor Red

return

}

else

{

$ResourceGroupName = $VM.CustomProperties[6]

Write-Host " Done! Cluster resource group name is '$ResourceGroupName'`n" -foregroundcolor Yellow

}

##################################################################################

# Get host cluster name which is Custom7 property of virtual machine host

##################################################################################

Write-Host "Trying to find current host of virtual machine $VMName..."

$VMHostName = ($VM.HostName).split(".")[0]

$VMHost = Get-VMHost -ComputerName $VMHostName

if ($VMHost -eq $null)

{

Write-Host " ERROR: Cannot find virtual machine host $VMHostName in VMM server $VMMServerName`n" -foregroundcolor Red

return

}

else

{

Write-Host " Done! Current host is $VMHostName`n" -foregroundcolor Yellow

}

Write-Host "Trying to get host cluster name by reading Custom7 property of host $VMHostName..."

if ($VMHost.Custom7 -eq "")

{

Write-Host " ERROR: $VMHostName does not appear to be a clustered host since its Custom7 property is blank`n" -foregroundcolor Red

return

}

else

{

$ClusterName = $VMHost.Custom7

Write-Host " Done! Host cluster name is $ClusterName `n" -foregroundcolor Yellow

}

##################################################################################

# Ensure that the host cluster exists

##################################################################################

Write-Host "Trying to connect to host cluster $ClusterName. This may take some time..."

$Cluster = Get-WmiObject -class MSCluster_Cluster -namespace root\mscluster -computerName $ClusterName

if ($Cluster -eq $null)

{

Write-Host " ERROR: Cannot connect to host cluster $ClusterName `n" -foregroundcolor Red

return

}

else

{

Write-Host " Done!`n" -foregroundcolor Yellow

}

##################################################################################

# Ensure that the current host is part of the host cluster

##################################################################################

Write-Host "Trying to find current host $VMHostName in host cluster $ClusterName..."

$Node = Get-WmiObject -class MSCluster_Node -namespace root\mscluster -computerName $ClusterName -filter "Name='$VMHostName'"

if ($Node -eq $null)

{

Write-Host " ERROR: Cannot find current host $VMHostName in host cluster $ClusterName`n" -foregroundcolor Red

return

}

else

{

Write-Host " Done!`n" -foregroundcolor Yellow

}

##################################################################################

# Ensure that the cluster resource group is owned by the current host

##################################################################################

Write-Host "Trying to find cluster resource group $ResourceGroupName on current host $VMHostName..."

$Query = "select * from MSCluster_NodeToActiveGroup where GroupComponent=`"MSCluster_Node.Name='$VMHostName'`" and PartComponent=`"MSCluster_ResourceGroup.Name='$ResourceGroupName'`""

$NodeToActiveGroup = Get-WmiObject -namespace root\mscluster -computerName $ClusterName -query $Query

if ($NodeToActiveGroup -eq $null)

{

Write-Host " ERROR: Cannot find cluster resource group $ResourceGroupName on current host $VMHostName`n" -foregroundcolor Red

return

}

else

{

$ResourceGroup = Get-WmiObject -class MSCluster_ResourceGroup -namespace root\mscluster -computerName $ClusterName -filter "Name='$ResourceGroupName'"

Write-Host " Done!`n" -foregroundcolor Yellow

}

##################################################################################

# Get the best rated target host

##################################################################################

Write-Host "Trying to select the best rated host having Custom7 set to $ClusterName as target for quick migration..."

$TargetVMHosts = @(Get-VMHost) | where {($_.Custom7 -eq $ClusterName) -and ($_.Name -ne $VMHost.Name)}

if ($TargetVMHosts -eq $null)

{

Write-Host " ERROR: Cannot find any target hosts having Custom7 set to $ClusterName`n" -foregroundcolor Red

return

}

else

{

$TargetVMHostRatings = @(Get-VMHostRating -VM $VM -VMHost $TargetVMHosts) | Sort-Object -property Rating -descending

Write-Host

Write-Host " TARGET HOST`t`tVMM RATING" -foregroundcolor DarkGray

Write-Host " ===========`t`t==========" -foregroundcolor DarkGray

foreach ($TargetVMHostRating in $TargetVMHostRatings)

{

Write-Host " ", ($TargetVMHostRating.Name).split(".")[0], "`t`t", $TargetVMHostRating.Rating -foregroundcolor DarkGray

}

Write-Host

$TargetHostName = (@($TargetVMHostRatings)[0].Name).split(".")[0]

Write-Host " Done! Selected target host $TargetHostName`n" -foregroundcolor Yellow

}

##################################################################################

# Ensure that the target host is part of the host cluster

##################################################################################

Write-Host "Trying to find target host $TargetHostName in host cluster $ClusterName..."

$Node = Get-WmiObject -class MSCluster_Node -namespace root\mscluster -computerName $ClusterName -filter "Name='$TargetHostName'"

if ($Node -eq $null)

{

Write-Host " ERROR: Cannot find target host $TargetHostName in host cluster $ClusterName`n" -foregroundcolor Red

return

}

else

{

Write-Host " Done!`n" -foregroundcolor Yellow

}

##################################################################################

# Move the cluster resource group to the target host

##################################################################################

Write-Host "Quick-migrating virtual machine $VMName to the best rated host $TargetHostName. This may take some time. "

$ResourceGroup.MoveToNewNode($TargetHostName, 30)

Write-Host " Done!`n" -foregroundcolor Yellow

Sample Scripts for Managing Virtual Machines

You can experiment with the Windows PowerShell scripts that are described in this topic to learn how to script the following tasks for virtual machines that are managed by Virtual Machine Manager:

 Automate creating multiple virtual machines.

 Install Virtual Machine Additions.

 Configure virtual machines in a two-node cluster.

 Adapt a script that is generated by an Administrator Console wizard to create virtual machines.

AutomateNewVMCreation.ps1

You can use the AutomateNewVMCreation.ps1 script to automate the creation of a specified number of virtual machines.

How AutomateNewVMCreation.ps1 Works

The following sections explain each part of the script AutomateNewVMCreation.ps1.

Define Variables for AutomateNewVMCreation.ps1

The first set of commands in AutomateNewVMCreation.ps1 defines variables that the script uses to create multiple virtual machines.

####################################################################

# Define variables

####################################################################

Each set of variables is described in the following sections.

Define a variable for the Virtual Machine Manager server

When you define a string variable for the name of your Virtual Machine Manager server, you can use "localhost" if the server is the local computer. However, if the Virtual Machine Manager server is remote, you must specify the fully qualified domain name (FQDN) of the server, such as ServerName.DomainName.com.

# Define a string variable for your VMM server.

$VMMServer = "localhost"

Define hardware profile parameters

A Virtual Machine Manager hardware profile stores hardware configuration information for a virtual machine. The script uses the hardware profile as one of the building blocks from which it creates a template; it then uses the template to create virtual machines. The script uses the parameters that are defined in the hardware profile to set:

 The hardware profile name.

 The amount of memory that is available to virtual machines that are created by the script.

Parameters that are not specified use the default settings. For more information about hardware profiles, type Get-Help New-HardwareProfile at the command prompt.

# Define hardware profile parameters.

$HWProfileName = "HwCfgWith1DVD1NIC512MBRam"

$MemoryInMB = 512

Define guest operating-system profile parameters

A Virtual Machine Manager guest operating system profile provides the operating system for a virtual machine. The script uses the guest operating-system profile as one of the building blocks from which it creates a template; it then uses the template to create virtual machines. The script uses the parameters that are defined in the guest operating-system profile to set:

 The guest operating-system profile name. A guest operating system is the operating system on a virtual machine, in contrast to a host operating system on the physical host computer on which one or more virtual machines are deployed.

 The product key. Substitute your 25-digit product key number for the X's.

 A password for the local Administrator account on the virtual machine.

 The full name. The name or role of the person in whose name the virtual machine, created by using this profile, is registered. This is the name that appears on the General tab of a computer's System Properties page under Registered to.

 The name of the workgroup to which the virtual machine belongs.

 The path to the SysPrep.inf text file, which is the unattended answer file that the System Preparation tool, SysPrep.exe, uses to automate deployment of Windows operating systems on multiple computers.

Parameters that are not specified use the default settings.

For more information about guest operating-system profiles, type Get-Help New-GuestOSProfile at the command prompt. For more information about SysPrep.inf and SysPrep.exe, see Microsoft Knowledge Base article 302577, "How to use the Sysprep tool to automate successful deployment of Windows XP" at http://go.microsoft.com/fwlink/?LinkId=104720.

# Define guest OS profile parameters.

$OSProfileName = "Win2K3R2Profile"

$ProductKey = "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX"

$AdminPassword = "!!123abc"

$FullName = "VMMUser"

$Workgroup = "VMWorkgroup"

$SysPrepScriptPath = "\\LibraryServer1.Contoso.com\MSSCVMMLibrary\Scripts\SysPrep.inf"

Define template parameters

A Virtual Machine Manager virtual machine template, which stores hardware configuration and guest operating-system information, can be used repeatedly to create new virtual machines. After creating a hardware profile and a guest operating-system profile, the script constructs a template using the parameters defined in the profiles and from a sysprepped virtual hard disk that contains the Windows Server 2003 R2 operating system. The example script assumes that you have a sysprepped virtual hard disk called ENU-W2003-Std-R2-Sysprep.vhd. The script uses the parameters that are define in the template to set:

 The name of the template.

 The path to the virtual hard disk that contains the sysprepped virtual hard disk.

Parameters that are not specified use the default settings. For more information about virtual machine templates, type Get-Help New-Template at the command prompt.

# Define template parameters.

$TemplateName = "Win2K3R2Template"

$SysPrepVHDPath = "\\LibraryServer1.Contoso.com\MSSCVMMLibrary\VHDs\ENU-W2003-Std-R2-Sysprep.vhd"

Define virtual machine parameters

After creating a template, the script uses it to create a virtual machine. The script uses the parameters that are defined in the template to set:

 A unique name for each virtual machine.

 The path to a second virtual hard disk that the script adds to each virtual machine. The example script assumes that you have a virtual hard disk called BaseDisk20GB.vhd. This virtual hard disk is other than the sysprepped virtual hard disk that is used to provide the operating system to the virtual machines.

 The number of virtual machines that are created by the script.

# Define virtual machine parameters.

$VMName = "VMN_"

$VMAdditionalVhdDiskPath = "\\LibraryServer1.Contoso.com\MSSCVMMLibrary\VHDs\BaseDisk20GB.vhd"

$NumVMs = 2

Define a Function That Creates a Secure Credential

The next set of commands in the script AutomateNewVMCreation.ps1 defines a function that the script uses to create a Windows PowerShell credential object (PSCredential object) by prompting the user for the user name and password that are required to join a computer to the domain.

####################################################################

# Define a function to create a PSCredential object.

####################################################################

function SecurePass {

param([string]$User, [string]$Password)

$SPassword = New-Object System.Security.SecureString

for ($i=0; $i -lt $Password.Length; $i++) {

$SPassword.AppendChar($Password[$i])

}

New-Object System.Management.Automation.PSCredential $User,$SPassword

}

Connect to the Virtual Machine Manager Server

The next command in the script AutomateNewVMCreation.ps1 connects to the Virtual Machine Manager server so that subsequent commands can access objects in the Virtual Machine Manager database. The command uses a value stored earlier in $VMMServer (in this case, localhost) to retrieve the server object from the Virtual Machine Manager library and store the server object in variable $C.

In this command, the parameter -ComputerName (as in: Get-VMMServer ComputerName $VMMServer) is assumed.

####################################################################

# Connect to the Virtual Machine Manager server.

####################################################################

$C = Get-VMMServer $VMMServer

Create a Hardware Profile

The next set of commands in the script AutomateNewVMCreation.ps1 creates a hardware profile with one DVD drive and one network adapter, and it sets the amount of memory to 512 RAM ($MemoryInMB was defined as 512 earlier).

Specifically, these commands perform the following tasks:

 The first command generates a GUID and stores the GUID in variable $HWProfileJobGroup. The job group ID functions as an identifier that groups subsequent commands in this set of commands into a single job group.

 The second command creates a virtual DVD drive but uses the JobGroup parameter to specify that the DVD drive is not created until just before the New-HardwareProfile cmdlet (in the last command) runs. Specifying Bus 1 and LUN 0 attaches the virtual DVD drive to Secondary Channel (0) on the IDE bus.

 The third command creates a virtual network adapter but uses the JobGroup parameter to specify that the network adapter is not created until just before the New-HardwareProfile cmdlet (in the last command) runs. This command sets the Ethernet address type to dynamic and uses the -NoConnection parameter to specify that the network adapter is not currently connected to a network.

 The last command creates and names a hardware profile. It specifies that the amount of memory on the host that a virtual machine (created by using this hardware profile) uses is 512 MB, and stores the hardware profile object in variable $HWProfile. Before the New-HardwareProfile cmdlet creates the hardware profile, the JobGroup parameter in this final command executes all of the preceding cmdlets that specify the same JobGroup GUID. When New-VirtualDVDDrive and New-VirtualNetworkAdapter run, the resulting objects that are created are automatically associated with the new hardware profile.

Later, the script incorporates this hardware profile into the virtual machine template that is created by the New-Template cmdlet.

####################################################################

# Create a hardware profile.

####################################################################

$HWProfileJobGroup = [System.Guid]::NewGuid()

New-VirtualDVDDrive -Bus 1 -Lun 0 -JobGroup $HWProfileJobGroup

New-VirtualNetworkAdapter -EthernetAddressType Dynamic -NoConnection -JobGroup $HWProfileJobGroup

$HWProfile = New-HardwareProfile -Name $HWProfileName -MemoryMB $MemoryInMB -JobGroup $HWProfileJobGroup

Create a Guest Operating-System Profile

The next set of commands in the script AutomateNewVMCreation.ps1 creates a guest operating system profile by performing the following tasks:

 The first command uses the Virtual Machine Manager cmdlet Get-Script to get all objects from the Virtual Machine Manager database that represent scripts and then uses the pipeline operator (|) to pass the objects to the standard Windows PowerShell cmdlet, Where-Object. Where-Object (whose alias is where) selects the object that represents the SysPrep.inf text file (which SysPrep.exe uses to automate deployment of Windows operating systems on multiple computers) and stores that object in variable $Script.

 The second command uses the SecurePass function, which was defined earlier, to create a secure password for the local Administrator account.

 The last command performs the following tasks:

 Creates and names a guest operating-system profile.

 Specifies a description.

 Sets the computer name to be randomly generated (indicated by the asterisk “*”).

 Specifies a product key.

 Specifies the role (VMMUser) of the person in whose name a virtual machine, created by using this profile, is registered.

 Specifies that any virtual machine that is created by using this profile is joined to the workgroup called VMWorkGroup.

 Provides the secure password, which was generated earlier by the SecurePass function.

 Specifies the SysPrep.inf file to be used for any virtual machine that is created by using this profile.

 Stores the guest operating-system profile object in variable $OSProfile.

Later, the script incorporates this guest operating-system profile into the virtual machine template that is created by the New-Template cmdlet.

####################################################################

# Create a guest OS profile from the SysPrep.inf script.

####################################################################

$Script = Get-Script | where {$_.SharePath -eq $SysPrepScriptPath}

$Cred = SecurePass "Administrator" $AdminPassword

$OSProfile = New-GuestOSProfile -Name $OSProfileName -Desc $OSProfileName -ComputerName "*" -ProductKey $ProductKey -FullName $FullName -JoinWorkgroup $Workgroup -AdminPasswordCredential $Cred -SysPrepFile $Script

Create a Template from a SysPrepped Virtual Hard Disk and from the Profiles

The next set of commands in the script AutomateNewVMCreation.ps1 constructs a template (used later in the script to create virtual machines) from the following components:

 The hardware profile and the guest operating-system profile, which was created earlier.

 A virtual hard disk that contains Windows Server 2003 R2, which has been prepared by the System Preparation Tool (Sysprep.exe).

Note

 Sysprep.exe must be run on the virtual hard disk to ensure that each copy of the operating system is unique when you distribute it to multiple virtual machines.

 You can find Sysprep.exe on any Windows Server 2003 (or Windows XP Professional) operating-system CD. Navigate to the Support\Tools folder, and then open Deploy.cab. The local Administrator password on the sysprepped virtual hard disk must be blank.

Specifically, the commands in this set perform the following tasks:

 The first command gets the object from the Virtual Machine Manager databases and stores the object in $Win2K3R2VHD. The object represents the sysprepped virtual hard disk that was stored earlier, with its path, in $SysPrepVHDPath.

 The second command generates a GUID and stores the GUID in variable $TemplateJobGroup. The job group ID functions as an identifier that groups subsequent commands in this set of commands into a single job group.

 The third command adds the virtual hard disk to the template (to be created in last step in this set of commands) but uses the JobGroup parameter to specify that the virtual hard disk is not attached until just before the New-Template cmdlet runs in the last step. Specifying Bus 0 and LUN 0 attaches the virtual hard disk to Primary Channel (0) on the IDE bus.

 The last command performs the following tasks:

 Creates and names the template.

 Provides a description, which is the same as the template name.

 Specifies that this template incorporates the hardware profile and guest operating-system profile that was created earlier.

 Uses the JobGroup parameter to specify that any of the preceding commands that include variable $TemplateJobGroup will run before New-Template creates the new template. After Add-VirtualHardDisk (the only command preceding this command that includes $TemplateJobGroup) runs, the resulting virtual hard disk object that is created is automatically associated with the new template.

Next, the script uses this template to create the number of virtual machines that is specified in $NumVMs.

####################################################################

# Create a template from the Win2K3R2 sysprepped VHD, hardware

# profile, and guest OS profile.

####################################################################

$Win2K3R2VHD = Get-VirtualHardDisk | where {$_.SharePath -eq $SysPrepVHDPath}

$TemplateJobGroup = [System.Guid]::NewGuid()

$Win2K3R2VHD | Add-VirtualHardDisk -Bus 0 -Lun 0 -IDE -JobGroup $TemplateJobGroup

$Template = New-Template -Name $TemplateName -Description $TemplateName -HardwareProfile $HWProfile -GuestOSProfile $OSProfile -JobGroup $TemplateJobGroup

Create the Virtual Machines from the Template, Add a Virtual Hard Disk, and Deploy Each Virtual Machine on a Host

The next set of commands in the script AutomateNewVMCreation.ps1 creates the specified number ($NumVMs) of virtual machines from the template that was created earlier, adds an additional virtual hard disk (which is not provided by the template) to each new virtual machine, and uses host ratings to determine the best host on which to deploy each virtual machine.

#####################################################################

# Create the specified number of VMs from the template (adding

# another VHD) and determine the best host on which to deploy each VM.

#####################################################################

Each set of commands for this part of the script is described in the following sections.

Create a random number

The first command creates a random number that the script uses later to create a unique name for each virtual machine.

# Create a random number used later to create a unique name for a VM.

$Random = (New-Object Random)

Get the additional virtual hard disk

The second command retrieves the object from the Virtual Machine Manager database that represents the virtual hard disk called BaseDisk20GB.vhd, which is located on the specified share, and stores the virtual hard disk object in variable $VMAdditionalVhd.

# Get the object that represents BaseDisk20GB.vhd.

$VMAdditionalVhd = Get-VirtualHardDisk | where {$_.SharePath -eq $VMAdditionalVhdDiskPath}

Get all hosts

The third command retrieves the objects from the Virtual Machine Manager database that represent all hosts on which you can deploy virtual machines.

# Get the objects that represent all hosts.

$VMHosts = Get-VMHost

Calculate hard disk space on the host required by a virtual machine

The fourth command calculates the total amount of hard disk space that is required on the physical host by a virtual machine. In this example script, the disk size is the same for each virtual machine because the script uses the same template to create all virtual machines.

# Calculate the amount of hard disk space required on the physical

# host by a VM.

$DiskSizeGB = ($Win2K3R2VHD.Size + $VMAdditionalVhd.Size) /1024 /1024 /1024

Create arrays for tasks and virtual machines

The fifth command creates variable arrays in which to store:

 Tasks. Objects that represent the tasks that the script runs as the script creates each virtual machine. $NumVMs indicates the size of the array.

 VMs. Objects that represent each new virtual machine. $NumVMs indicates the size of the array.

# Create variable arrays in which to store tasks and VMS.

$NewVMTasks = [System.Array]::CreateInstance("Microsoft.SystemCenter.VirtualMachineManager.Task", $NumVMs)

$NewVMs = [System.Array]::CreateInstance("Microsoft.SystemCenter.VirtualMachineManager.VM", $NumVMs)

Create and deploy each virtual machine

The last command uses a while loop to create each virtual machine asynchronously. The loop performs the following tasks:

 Generates a unique name for each virtual machine and stores the object that represents the new name in variable $NewVMName. Each name is prefixed with the contents of $VMName and includes a random number in the name.

 Gets the placement rating for each host that meets the virtual machine requirements specified in the template, and sorts the hosts by placement rating. The rating indicates the suitability of a computer (or a set of computers in a host group) to serve as a host for a virtual machine with a specific hardware configuration.

 Uses an if statement to create virtual machines on hosts whose rating is greater than zero:

 The first command in the if statement stores the object for each host whose rating is greater than zero in variable $VMHost.

 The second command in the if statement is the path to which each virtual machine is to be deployed on the hosts in variable $VMPath.

 The third command in the if statement generates a GUID and stores the GUID in variable $NewVMJobGroup. The job group ID functions as an identifier that groups subsequent commands in this set of commands into a single job group..

 The fourth command in the if statement uses the pipeline operator (|) to pass the contents of $VMAdditionalVhd to the Add-VirtualHardDisk cmdlet, which adds a virtual hard disk to the virtual machine but uses the JobGroup parameter to specify that the virtual hard disk is not attached until just before the New-VM cmdlet runs in the next step. Specifying -Bus 0 -Lun 1 attaches the virtual hard disk to the Primary Channel (1) on the built-in IDE bus.

 The fifth command in the if statement provides a name and description for a new virtual machine; creates the new virtual machine based on the settings specified in the template; deploys the new virtual machine on a host at the specified path; uses the -RunAsynchronously parameter returns control to the shell immediately ,before the command is completed; and starts the virtual machine. Before the New-VM cmdlet creates the virtual machine, the JobGroup parameter in this command runs all of the preceding cmdlets that specify the same JobGroup GUID. After Add-VirtualHardDisk (the only command preceding this command that includes $NewVMJobGroup) runs, the resulting virtual hard disk object that is created is automatically associated with the new virtual machine. This command stores the object that represents the new virtual machine in variable array $NewVMs.

 The sixth command in the if statement stores the object that represents the most recent task in the variable array $NewVMTasks.

 The last command in the if statement increments the index.

 The next command in the while statement ($NumVMs - 1) subtracts one from the number of virtual machines to be created by the while loop.

 The last command in the while statement uses the standard Windows PowerShell Start-Sleep cmdlet to suspend execution of the while statement for five seconds to allow time for the operation to finish before the while loop repeats.

$i = 0

# Loop that creates each VM asynchronously.

while($NumVMs -gt 0)

{

# Generate a unique VM name.

$VMRnd = $Random.next()

$NewVMName = $VMName+$VMRnd

# Get the ratings for each host and sort the hosts by ratings.

$Ratings = @(Get-VMHostRating -Template $Template -VMHost $VMHosts -DiskSpaceGB $DiskSizeGB -VMName $NewVMName | where { $_.Rating -gt 0} | Sort-Object -property Rating -descending)

if ($Ratings.Count -gt 0)

{

$VMHost = $Ratings[0].VMHost

$VMPath = $Ratings[0].VMHost.VMPaths[0]

# Create a new VM from the template and add an additional VHD

# to the VM.

$NewVMJobGroup = [System.Guid]::NewGuid()

$VMAdditionalVhd | Add-VirtualHardDisk -Bus 0 -Lun 1 -IDE -JobGroup $NewVMJobGroup

$NewVMs[$i] = New-VM -Template $Template -Name $NewVMName -Description $NewVMName -VMHost $VMHost -Path $VMPath -RunAsynchronously -StartVM -JobGroup $NewVMJobGroup

$NewVMTasks[$i] = $NewVMs[$i].MostRecentTask

$i = $i + 1

}

$NumVMs = $NumVMs - 1

Start-Sleep -seconds 5

}

Display Progress Messages

The next set of commands in the script AutomateNewVMCreation.ps1 displays a progress message about each task as the script creates each new virtual machine.

####################################################################

# Wait for all of the tasks to complete, and provide a progress

# message about each task.

####################################################################

$Done = 0

while($Done -eq 0)

{

$Done = 1

Start-Sleep -seconds 5

ForEach($Task in $NewVMTasks)

{

echo "##############################"

echo $Task.ResultName "VM creation" $Task.Status $Task.Progress Complete $Task.ErrorInfo.Problem

echo "##############################"

echo ""

if($Task.Status -eq "Running")

{

$done = 0

}

Display Results Messages

The final set of commands in the script AutomateNewVMCreation.ps1 displays a message indicating the result as the script creates each new virtual machine.

####################################################################

# Display results.

####################################################################

ForEach($Task in $NewVMTasks)

{

echo "##############################"

echo $Task.ResultName "VM creation " $Task.Status "Start time" $Task.StartTime.DateTime "End time" $Task.EndTime.DateTime $Task.ErrorInfo.Problem

echo "##############################"

echo ""

}

AutomateNewVMCreation.ps1 - Complete Script

Copy the following complete version of AutomateNewVMCreation.ps1 into a Notepad file, and save it as AutomateNewVMCreation.ps1.

# Filename: AutomateNewVMCreation.ps1

# Description: Create a System Center Virtual Machine Manager-based

# hardware profile and operating-system profile; use

# these profiles and a sysprepped VHD to create a

# template; use the template to create 'n' number of

# virtual machines, adding an additional VHD to each

# new VM; and deploy each virtual machine on the most

# suitable host. Display progress messages for each task

# and display a final status message for attempt to

# create a virtual machine.

# DISCLAIMER:

# script is made available to you without any express, implied or

# statutory warranty, not even the implied warranty of

# merchantability or fitness for a particular purpose, or the

# warranty of title or non-infringement. The entire risk of the

# use or the results from the use of this script remains with you.

####################################################################

# Define variables

####################################################################

# Define a string variable for your VMM server.

$VMMServer = "localhost"

# Define hardware profile parameters.

$HWProfileName = "HwCfgWith1DVD1NIC512MBRam"

$MemoryInMB = 512

# Define guest OS profile parameters.

$OSProfileName = "Win2K3R2Profile"

$ProductKey = "C938K-6CHYF-2K8VH-FX94R-XVQ2J"

$AdminPassword = "!!123abc"

$FullName = "VMMUser"

$Workgroup = "VMWorkgroup"

$SysPrepScriptPath = "\\LibraryServer1.Contoso.com\MSSCVMMLibrary\Scripts\SysPrep.inf"

# Define template parameters.

$TemplateName = "Win2K3R2Template"

$SysPrepVHDPath = "\\LibraryServer1.Contoso.com\MSSCVMMLibrary\VHDs\ENU-W2003-Std-R2-Sysprep.vhd"

# Define VM parameters.

$VMName = "VMN_"

$VMAdditionalVhdDiskPath = "\\LibraryServer1.Contoso.com\MSSCVMMLibrary\VHDs\BaseDisk20GB.vhd"

$NumVMs = 2

####################################################################

# Define a function to create a PSCredential object.

####################################################################

function SecurePass {

param([string]$User, [string]$Password)

$SPassword = New-Object System.Security.SecureString

for ($i=0; $i -lt $Password.Length; $i++) {

$SPassword.AppendChar($Password[$i])

}

New-Object System.Management.Automation.PSCredential $User,$SPassword

}

####################################################################

# Connect to the Virtual Machine Manager server.

####################################################################

$C = Get-VMMServer $VMMServer

####################################################################

# Create a hardware profile.

####################################################################

$HWProfileJobGroup = [System.Guid]::NewGuid()

New-VirtualDVDDrive -Bus 1 -Lun 0 -JobGroup $HWProfileJobGroup

New-VirtualNetworkAdapter -EthernetAddressType Dynamic -NoConnection -JobGroup $HWProfileJobGroup

$HWProfile = New-HardwareProfile -Name $HWProfileName -MemoryMB $MemoryInMB -JobGroup $HWProfileJobGroup

####################################################################

# Create a guest OS profile from the SysPrep.inf script.

####################################################################

$Script = Get-Script | where {$_.SharePath -eq $SysPrepScriptPath}

$Cred = SecurePass "Administrator" $AdminPassword

####################################################################

# Create a template from the Win2K3R2 sysprepped VHD, hardware

# profile, and guest OS profile.

####################################################################

$Win2K3R2VHD = Get-VirtualHardDisk | where {$_.SharePath -eq $SysPrepVHDPath}

$TemplateJobGroup = [System.Guid]::NewGuid()

$Win2K3R2VHD | Add-VirtualHardDisk -Bus 0 -Lun 0 -IDE -JobGroup $TemplateJobGroup

$Template = New-Template -Name $TemplateName -Description $TemplateName -HardwareProfile $HWProfile -GuestOSProfile $OSProfile -JobGroup $TemplateJobGroup

#####################################################################

# Create the specified number of VMs from the template (adding

# another VHD) and determine the best host on which to deploy each VM.

#####################################################################

# Create a random number used later to create a unique name for a VM.

$Random = (New-Object Random)

# Get the object that represents BaseDisk20GB.vhd.

$VMAdditionalVhd = Get-VirtualHardDisk | where {$_.SharePath -eq $VMAdditionalVhdDiskPath}

# Get the objects that represent all hosts.

$VMHosts = Get-VMHost

# Calculate the amount of hard disk space required on the physical

# host by a VM.

$DiskSizeGB = ($Win2K3R2VHD.Size + $VMAdditionalVhd.Size) /1024 /1024 /1024

# Create variable arrays in which to store tasks and VMS.

$NewVMTasks = [System.Array]::CreateInstance("Microsoft.SystemCenter.VirtualMachineManager.Task", $NumVMs)

$NewVMs = [System.Array]::CreateInstance("Microsoft.SystemCenter.VirtualMachineManager.VM", $NumVMs)

$i = 0

# Loop that creates each VM asynchronously.

while($NumVMs -gt 0)

{

# Generate a unique VM name.

$VMRnd = $Random.next()

$NewVMName = $VMName+$VMRnd

# Get the ratings for each host and sort the hosts by ratings.

$Ratings = @(Get-VMHostRating -Template $Template -VMHost $VMHosts -DiskSpaceGB $DiskSizeGB -VMName $NewVMName | where { $_.Rating -gt 0} | Sort-Object -property Rating -descending)

if ($Ratings.Count -gt 0)

{

$VMHost = $Ratings[0].VMHost

$VMPath = $Ratings[0].VMHost.VMPaths[0]

# Create a new VM from the template and add an additional VHD

# to the VM.

$NewVMJobGroup = [System.Guid]::NewGuid()

$VMAdditionalVhd | Add-VirtualHardDisk -Bus 0 -Lun 1 -IDE -JobGroup $NewVMJobGroup

$NewVMs[$i] = New-VM -Template $Template -Name $NewVMName -Description $NewVMName -VMHost $VMHost -Path $VMPath -RunAsynchronously -StartVM -JobGroup $NewVMJobGroup

$NewVMTasks[$i] = $NewVMs[$i].MostRecentTask

$i = $i + 1

}

$NumVMs = $NumVMs - 1

Start-Sleep -seconds 5

}

####################################################################

# Wait for all of the tasks to complete, and provide a progress

# message about each task.

####################################################################

$Done = 0

while($Done -eq 0)

{

$Done = 1

Start-Sleep -seconds 5

ForEach($Task in $NewVMTasks)

{

echo "##############################"

echo $Task.ResultName "VM creation" $Task.Status $Task.Progress Complete $Task.ErrorInfo.Problem

echo "##############################"

echo ""

if($Task.Status -eq "Running")

{

$done = 0

}

####################################################################

# Display results.

####################################################################

ForEach($Task in $NewVMTasks)

{

echo "##############################"

echo $Task.ResultName "VM creation " $Task.Status "Start time" $Task.StartTime.DateTime "End time" $Task.EndTime.DateTime $Task.ErrorInfo.Problem

echo "##############################"

echo ""

}

InstallVMAdditions.ps1

You can use the InstallVMAdditions.ps1 script to install Virtual Machine Additions on virtual machines that are managed by Virtual Machine Manager.

For any virtual machine to function well, you must install Virtual Machine Additions on that virtual machine. Virtual Machine Additions, which is provided by Virtual Server 2005, improves the performance of the guest operating system, enables the free movement of the mouse between the virtual machine window and the host operating system, optimizes video drivers, and supports time synchronization.

For a related script that identifies which virtual machines in your Virtual Machine Manager environment do not yet have Virtual Machine Additions installed, see NeedVMAdditions.ps1 in the topic, "Sample Job-Related Scripts" in this guide.

How InstallVMAdditions.ps1 Works

The following sections explain each part of the script InstallVMAdditions.ps1.

Define Variables for InstallVMAdditions.ps1

The first commands in InstallVMAdditions.ps1 define variables that the script uses to install Virtual Machine Additions. As indicated in the comment introducing $LinkIso, you have the option to set $LinkIso to $TRUE or $FALSE depending on whether you want to link to the VMAdditions.iso or copy it onto the virtual machine.

####################################################################

# Define variables.

####################################################################

$VMMServer = "localhost"

$VMNameToInstallVMAdditions = "VM01"

# If you want to link to VMAdditons.iso in the Virtual Machine Manager

# library, set $LinkIso to $TRUE; alternatively, if you want to copy

# VMAdditions.iso to the VM, set $LinkIso to $FALSE.

$LinkIso = $FALSE

Connect to the Virtual Machine Manager Server

The next command in InstallVMAdditions.ps1connects to the Virtual Machine Manager server so that subsequent commands can access objects in the Virtual Machine Manager database.

####################################################################

# Connect to the Virtual Machine Manager server.

####################################################################

$C = Get-VMMServer $VMMServer

Get the Virtual Machine on Which to Install Virtual Machine Additions.

The next command in InstallVMAdditions.ps1 retrieves the object that represents the virtual machine whose name was stored earlier in variable $VMNameToInstallVMAdditions.

####################################################################

# Get the VM on which you want to install VM Additions.

####################################################################

$VM = Get-VM | where {$_.Name -eq $VMNameToInstallVMAdditions}

Install Virtual Machine Additions or Display an Error Message

The next set of commands in InstallVMAdditions.ps1 performs a series of nested tests to determine whether it is possible to install Virtual Machine Additions and, if any test fails, displays an error message indicating what you need to do to solve the problem.

 Is the virtual machine installed on a host?

 If yes, continue to the next question.

 If not, the script ends and displays a message indicating that it cannot install Virtual Machine Additions because the virtual machine is currently stored in the library. You must deploy the virtual machine on a host and then run the script again. For more information, type the following command at the command prompt:

Get Help Move-VM -detailed

 Does the virtual machine have at least one virtual DVD drive?

 If yes, the script does the following:

Stores host object. Stores the object that represents the host on which this virtual machine is deployed in variable $VmHost.

Stores ISO name string. Uses the command segment $VmHost.VirtualizationStack to determine which version of Virtual Server is running on the host (because Virtual Machine Additions varies depending on the Virtual Server version); concatenates the Virtual Server version with the string " VMAdditions"; and then stores the resulting name in variable $Isoname. The example assumes that Virtual Server version plus " VMAdditions" is the naming convention that is used to identify different versions of Virtual Machine Additions.

Gets ISO object. Gets the object that represents the Virtual Machine Additions .iso file in variable $VmAdditions.Iso.

Continue to the next question.

 If not, the script ends and displays a message indicating that it cannot install Virtual Machine Additions because no virtual DVD drive exists on the virtual machine. You must configure a virtual DVD drive for this virtual machine and then run the script again. For more information, type the following command at the command prompt:

Get-Help New-VirtualDVDDrive -detailed

 Does at least one Virtual Machine Additions .iso file (of the correct version) exist in the library?

 If yes, continue to the next question.

 If not, the script ends and displays a message indicating that it cannot install Virtual Machine Additions because no Virtual Machine Additions .iso file exists in the Virtual Machine Manager library. You must add an .iso file for Virtual Machine Additions to a Virtual Machine Manager library share and then run the script again.

After you add the .iso file to a library share, the Virtual Machine Manager refresher automatically scans the share, discovers the new .iso file, and adds an object that represents the .iso file to the library catalog. Alternatively, you can use the Refresh-LibraryShare cmdlet to refresh the library share immediately.

For more information, type the following command at the command prompt:

Get-Help Refresh-LibraryShare -detailed

Note

You can copy the VMAdditions.iso file from Microsoft Virtual Server 2005, which is installed by default with Virtual Machine Manager. You can find the VMAdditions.iso file in Windows Explorer at <C>:\Program Files\Microsoft Virtual Server\Virtual Machine Additions.

 Do you want to link to or copy the .iso file?

 Link to? If you have set $LinkIso to $TRUE, the script uses the pipeline operator (|) to pass the first virtual DVD drive (indicated by [0]) on the virtual machine to the Set-VirtualDVDDrive cmdlet, which links to the Virtual Machine Additions .iso file in the library.

The command segment -Bus $VM.VirtualDVDDrives[0].Bus -Lun $VM.VirtualDVDDrives[0].Lun must be specified when changing the attached .iso file of a virtual DVD drive. In this case, the script does not modify where the virtual DVD drive is attached, so it simply sets the -Bus and -Lun parameters to the current Bus and Lun settings. Finally, the script stores the resulting object in variable $DVDDrive in case you want to use this variable later on.

 Copy? If you have set $LinkIso to $FALSE, the script uses the pipeline operator (|) to pass the first virtual DVD drive (indicated by [0]) on the virtual machine to the Set-VirtualDVDDrive cmdlet, which copies the Virtual Machine Additions .iso file onto the virtual machine.

Note

The second command omits the -Link parameter but uses the $FALSE value specified earlier. By default, if -Link is omitted, the Set-VirtualDVDDrive cmdlet copies a file rather than linking to it.

 Link to or Copy—same result: After the script either runs the command to link to the Virtual Machine Additions .iso file in the library or runs the command to copy the .iso file to the virtual machine, the script displays a message indicating that the Virtual Machine Additions .iso file is now attached to the virtual machine and requests the user to start the virtual machine and install Virtual Machine Additions from the virtual DVD drive.

####################################################################

# Install VM Additions or (if not possible) display an error message.

####################################################################

if($VM.HostType -eq "VMHost")

{

if($VM.VirtualDVDDrives.Count -gt 0)

{

$VmHost = $VM.VMHost

# The segment$VmHost.VirtualizationStack returns the version

# of Virtual Server running on this host.

$IsoName = $VmHost.VirtualizationStack +" VMAdditions"

$VmAdditionIso = Get-ISO | where {$_.Name -eq $IsoName}

if($Null -ne $VmAdditionIso)

{

if($LinkIso -eq $TRUE)

{

$DvdDrive = $VM.VirtualDVDDrives[0] | set-VirtualDVDDrive -ISO $VmAdditionIso -Link -Bus $VM.VirtualDVDDrives[0].Bus -Lun $VM.VirtualDVDDrives[0].Lun

}

else

{

$DvdDrive = $VM.VirtualDVDDrives[0] | set-VirtualDVDDrive -ISO $VmAdditionIso -Bus $VM.VirtualDVDDrives[0].Bus -Lun $VM.VirtualDVDDrives[0].Lun

}

echo "Attached " $VmAdditionIso.Name " to VM" $VM.Name " Please start the vm if not running and install additions from dvddrive"

}

else

{

echo "Can't install vmadditions on VM " $VM.Name " as $IsoName ISO not present, please add it to library and retry"

}

else

{

echo "Can't install vmadditions on VM " $VM.Name " has no VirtualDVDDrives present, please add a dvddrive and retry"

}

else

{

echo "Can't install vmadditions on VM " $VM.Name " in library, please deploy to host and retry"

}

InstallVMAdditions.ps1 - Complete Script

Copy the following complete version of InstallVMAdditions.ps1 into a Notepad file, and save it as InstallVMAdditions.ps1.

# Filename: InstallVMAdditions.ps1

# Description: Create a System Center Virtual Machine Manager-based

# hardware profile and operating-system profile; use

# these profiles and a sysprepped VHD to create a

# template; use the template to create 'n' number of

# virtual machines, adding an additional VHD to each

# new VM; and deploy each virtual machine on the most

# suitable host. Display progress messages for each task

# and display a final status message for attempt to

# create a virtual machine.

# DISCLAIMER:

# script is made available to you without any express, implied or

# statutory warranty, not even the implied warranty of

# merchantability or fitness for a particular purpose, or the

# warranty of title or non-infringement. The entire risk of the

# use or the results from the use of this script remains with you.

####################################################################

# Define variables

####################################################################

$VMMServer = "localhost"

$VMNameToInstallVMAdditions = "VM01"

# If you want to link to VMAdditons.iso in the Virtual Machine Manager

# library, set $LinkIso to $TRUE; alternatively, if you want to copy

# VMAdditions.iso to the VM, set $LinkIso to $FALSE.

$LinkIso = $FALSE

####################################################################

# Connect to the Virtual Machine Manager server.

####################################################################

$C = Get-VMMServer $VMMServer

####################################################################

# Get the VM on which you want to install VM Additions.

####################################################################

$VM = Get-VM | where {$_.Name -eq $VMNameToInstallVMAdditions}

####################################################################

# Install VM Additions or (if not possible) display an error message.

####################################################################

if($VM.HostType -eq "VMHost")

{

if($VM.VirtualDVDDrives.Count -gt 0)

{

$VmHost = $VM.VMHost

# The segment$VmHost.VirtualizationStack returns the version

# of Virtual Server running on this host

$IsoName = $VmHost.VirtualizationStack +" VMAdditions"

$VmAdditionIso = Get-ISO | where {$_.Name -eq $IsoName}

if($Null -ne $VmAdditionIso)

{

if($LinkIso -eq $TRUE)

{

$DvdDrive = $VM.VirtualDVDDrives[0] | set-VirtualDVDDrive -ISO $VmAdditionIso -Link -Bus $VM.VirtualDVDDrives[0].Bus -Lun $VM.VirtualDVDDrives[0].Lun

}

else

{

$DvdDrive = $VM.VirtualDVDDrives[0] | set-VirtualDVDDrive -ISO $VmAdditionIso -Bus $VM.VirtualDVDDrives[0].Bus -Lun $VM.VirtualDVDDrives[0].Lun

}

echo "Attached " $VmAdditionIso.Name " to VM" $VM.Name " Please start the vm if not running and install additions from dvddrive"

}

else

{

echo "Can't install vmadditions on VM " $VM.Name " as $IsoName ISO not present, please add it to library and retry"

}

else

{

echo "Can't install vmadditions on VM " $VM.Name " has no VirtualDVDDrives present, please add a dvddrive and retry"

}

else

{

echo "Can't install vmadditions on VM " $VM.Name " in library, please deploy to host and retry"

}

ConfigureGuestCluster.ps1

Virtual Server 2005, on which Virtual Machine Manager is built, allows for two-node guest clusters with servers implemented as virtual machines connected to a virtual shared cluster storage device. A guest cluster supports availability of server resources and applications to clients in an environment where availability does not require hardware redundancy.

You can use the ConfigureGuestCluster.ps1 script to set up two virtual machines in a two-node server cluster.

How ConfigureGuestCluster.ps1Works

The following sections explain each part of the script ConfigureGuestCluster.ps1.

Define Variables for ConfigureGuestCluster.ps1

The first commands in ConfigureGuestCluster.ps1 define variables that the script uses to configure a quorum disk and shared disk when setting up virtual machines in a two-node guest cluster.

####################################################################

# Define variables

####################################################################

$VMMServer = "localhost"

$vmNode1Name = "VMN_1228156997"

$vmNode2Name = "VMN_1480103423"

$QuorumDiskSizeInGB = 3

$QuorumDiskName = "QuorumDisk"

$SharedDiskSizeInGB = 8

$SharedDiskName = "SharedDisk"

Connect to the Virtual Machine Manager Server

The next command in ConfigureGuestCluster.ps1 connects to the Virtual Machine Manager server so that subsequent commands can access objects in the Virtual Machine Manager database.

####################################################################

# Connect to the Virtual Machine Manager server.

####################################################################

$C = Get-VMMServer $VMMServer

Get the Virtual Machines to Configure as a Two-Node Cluster

The next two commands retrieve from the Virtual Machine Manager database the objects that represent the two virtual machines that you want to use in a two-node cluster and stores each virtual machine object in a variable.

####################################################################

# Get both virtual machine nodes.

####################################################################

$vmNode1 = Get-VM | where {$_.Name -eq $vmNode1Name}

$vmNode2 = Get-VM | where {$_.Name -eq $vmNode2Name}

Create Two Shared SCSI Adapters for the First Node

When you create the two-node cluster using virtual machines, you must create two shared SCSI adapters on each node. This set of commands creates two shared SCSI adapters on the first node.

Specifically, the set of commands in this section performs the following tasks:

 The first command generates a GUID and stores the GUID in variable $JobGroup1. The job group ID functions as an identifier that groups subsequent commands in this set of commands into a single job group.

 The second and third commands create two virtual SCSI adapters on the first virtual machine, but use the JobGroup parameter to specify that the virtual SCSI adapters are not created until the Set-VM cmdlet (in the last command) runs.

 The fourth command passes the object that represents the first virtual machine to the Set-VM cmdlet, which runs the two preceding cmdlets that specify the same JobGroup GUID, so that the two virtual SCSI adapters are actually created in this step.

####################################################################

# Create two shared SCSI adapters on vmNode1.

####################################################################

$JobGroup1 = [System.Guid]::NewGuid()

New-VirtualSCSIAdapter -Shared $True -JobGroup $JobGroup1

$vmNode1 | Set-VM -JobGroup $JobGroup1

Create Two Shared SCSI Adapters for the Second Node

This set of commands creates two shared SCSI adapters on the second node.

####################################################################

# Create two shared SCSI adapters on vmNode2.

####################################################################

$JobGroup2 = [System.Guid]::NewGuid()

New-VirtualSCSIAdapter -Shared $True -JobGroup $JobGroup2

$vmNode2 | Set-VM -JobGroup $JobGroup2

Create a Quorum Virtual Hard Disk on the First Node

A two-node guest cluster requires a quorum disk, which is a virtual hard disk that is used to store cluster configuration information. This command performs the following tasks:

 Creates a fixed virtual hard disk on the first virtual machine.

 Attaches it to the specified location (-Bus 0 -Lun 0) on the SCSI bus.

 Names it QuorumDisk (the value of $QuorumDiskName).

 Specifies that its size is 3 GB (the value of $QuorumDiskSizeInGB).

 Stores the object that represents the new quorum virtual hard disk in variable $QuorumVHD.

####################################################################

# Create a new quorum VHD of size $QuorumDiskSizeInGB on $vmNode1.

####################################################################

$QuorumVHD = New-VirtualHardDisk -VM $vmNode1 -Fixed -SCSI -Bus 0 -Lun 0 -Filename $QuorumDiskName -Size $QuorumDiskSizeInGB

Create a Shared Virtual Hard Disk on the First Node

The command in this section, which creates a shared virtual hard disk on the first node, performs the following tasks:

 Creates a fixed virtual hard disk on the first virtual machine.

 Attaches it to the specified location (-Bus 1 -Lun 0) on the SCSI bus.

 Names it SharedDisk (the value of $SharedDiskName).

 Specifies that its size is 8 GB (the value of $SharedDiskSizeInGB).

 Stores the object that represents the new shared virtual hard disk in variable $SharedVHD.

####################################################################

# Create a new shared VHD of size $SharedDiskSizeInGB on $vmNode1.

####################################################################

$SharedVHD = New-VirtualHardDisk -VM $vmNode1 -Fixed -SCSI -Bus 1 -Lun 0 -Filename $SharedDiskName -Size $SharedDiskSizeInGB

Attach the Quorum and Shared Virtual Hard Disks Created on the First Node to the Second Node

After creating the quorum virtual hard disk and the shared virtual hard disk on the virtual machine that acts as the first node in the two-node cluster, you must attach both of these virtual hard disks to the second node.

Specifically, the commands in this section perform the following tasks:

The first command adds the quorum virtual hard disk on the first node to the specified location (-Bus 0 -Lun 0) on the second node.

The second command adds the shared virtual hard disk on the first node to the specified location (-Bus 1 -Lun 0) on the second node.

####################################################################

# Attach QuorumVHD and SharedVHD created on $vmNode1 to $vmNode2

####################################################################

Add-VirtualHardDisk -VirtualHardDisk $QuorumVHD -SCSI -Bus 0 -Lun 0 -VM $vmNode2

Add-VirtualHardDisk -VirtualHardDisk $SharedVHD -SCSI -Bus 1 -Lun 0 -VM $vmNode2

ConfigureGuestCluster.ps1 - Complete Script

Copy the following complete version of ConfigureGuestCluster.ps1 into a Notepad file, and save it as ConfigureGuestCluster.ps1.

# Filename: ConfigureGuestCluster.ps1

# Description: Configure two virtual machines managed by System Center

# Virtual Machine Manager as a two-node cluster.

# DISCLAIMER:

# script is made available to you without any express, implied or

# statutory warranty, not even the implied warranty of

# merchantability or fitness for a particular purpose, or the

# warranty of title or non-infringement. The entire risk of the

# use or the results from the use of this script remains with you.

####################################################################

# Define variables

####################################################################

$VMMServer = "localhost"

$vmNode1Name = "VMN_1228156997"

$vmNode2Name = "VMN_1480103423"

$QuorumDiskSizeInGB = 3

$QuorumDiskName = "Quorumdisk"

$SharedDiskSizeInGB = 8

$SharedDiskName = "SharedDisk"

####################################################################

# Connect to the Virtual Machine Manager server.

####################################################################

$C = Get-VMMServer $VMMServer

####################################################################

# Get both virtual machine nodes.

####################################################################

$vmNode1 = Get-VM | where {$_.Name -eq $vmNode1Name}

$vmNode2 = Get-VM | where {$_.Name -eq $vmNode2Name}

####################################################################

# Create two shared SCSI adapters on vmNode1.

####################################################################

$JobGroup1 = [System.Guid]::NewGuid()

New-VirtualSCSIAdapter -Shared $True -JobGroup JobGroup1

$vmNode1 | Set-VM -JobGroup JobGroup1

####################################################################

# Create two shared SCSI adapters on vmNode2.

####################################################################

JobGroup2 = [System.Guid]::NewGuid()

New-VirtualSCSIAdapter -Shared $True -JobGroup JobGroup2

$vmNode2 | Set-VM -JobGroup JobGroup2