LabBuilder-help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-Lab</command:name> <command:verb>Get</command:verb> <command:noun>Lab</command:noun> <maml:description> <maml:para>Loads a Lab Builder Configuration file and returns a Lab object</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Takes the path to a valid LabBuilder Configiration XML file and loads it.</maml:para> <maml:para>It will perform simple validation on the XML file and throw an exception if any of the validation tests fail.</maml:para> <maml:para>At load time it will also add temporary configuration attributes to the in memory configuration that are used by other LabBuilder functions. So loading XML Configurartion without using this function is not advised.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-Lab</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ConfigPath</maml:name> <maml:Description> <maml:para>This is the path to the Lab Builder configuration file to load.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>LabPath</maml:name> <maml:Description> <maml:para>This is an optional path that is used to Override the LabPath in the config file passed.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>SkipXMLValidation</maml:name> <maml:Description> <maml:para>{{Fill SkipXMLValidation Description}}</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ConfigPath</maml:name> <maml:Description> <maml:para>This is the path to the Lab Builder configuration file to load.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>LabPath</maml:name> <maml:Description> <maml:para>This is an optional path that is used to Override the LabPath in the config file passed.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>SkipXMLValidation</maml:name> <maml:Description> <maml:para>{{Fill SkipXMLValidation Description}}</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>The Lab object representing the Lab Configuration that was loaded.</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$MyLab = Get-Lab -ConfigPath c:\MyLab\LabConfig1.xml</dev:code> <dev:remarks> <maml:para>Loads the LabConfig1.xml configuration and returns Lab object.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LabResourceISO</command:name> <command:verb>Get</command:verb> <command:noun>LabResourceISO</command:noun> <maml:description> <maml:para>Gets an array of ISO Resources from a Lab.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Takes a provided Lab and returns the list of ISO resources required for this Lab.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-LabResourceISO</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Lab</maml:name> <maml:Description> <maml:para>Contains the Lab object that was loaded by the Get-Lab object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>An optional array of ISO names.</maml:para> <maml:para>Only ISO Resources matching names in this list will be pulled into the returned in the array.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Lab</maml:name> <maml:Description> <maml:para>Contains the Lab object that was loaded by the Get-Lab object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>An optional array of ISO names.</maml:para> <maml:para>Only ISO Resources matching names in this list will be pulled into the returned in the array.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Returns an array of LabISOResource objects</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$Lab = Get-Lab -ConfigPath c:\mylab\config.xml</dev:code> <dev:remarks> <maml:para>$ResourceISO = Get-LabResourceISO $Lab Loads a Lab and pulls the array of ISO Resources from it.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LabResourceModule</command:name> <command:verb>Get</command:verb> <command:noun>LabResourceModule</command:noun> <maml:description> <maml:para>Gets an array of Module Resources from a Lab.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Takes a provided Lab and returns the list of module resources required for this Lab.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-LabResourceModule</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Lab</maml:name> <maml:Description> <maml:para>Contains the Lab object that was loaded by the Get-Lab object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>An optional array of Module names.</maml:para> <maml:para>Only Module Resources matching names in this list will be pulled into the returned in the array.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Lab</maml:name> <maml:Description> <maml:para>Contains the Lab object that was loaded by the Get-Lab object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>An optional array of Module names.</maml:para> <maml:para>Only Module Resources matching names in this list will be pulled into the returned in the array.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Returns an array of LabModuleResource objects</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$Lab = Get-Lab -ConfigPath c:\mylab\config.xml</dev:code> <dev:remarks> <maml:para>$ResourceModules = Get-LabResourceModule -Lab $Lab Loads a Lab and pulls the array of Module Resources from it.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LabResourceMSU</command:name> <command:verb>Get</command:verb> <command:noun>LabResourceMSU</command:noun> <maml:description> <maml:para>Gets an array of MSU Resources from a Lab.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Takes a provided Lab and returns the list of MSU resources required for this Lab.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-LabResourceMSU</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Lab</maml:name> <maml:Description> <maml:para>Contains the Lab object that was loaded by the Get-Lab object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>An optional array of MSU names.</maml:para> <maml:para>Only MSU Resources matching names in this list will be pulled into the returned in the array.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Lab</maml:name> <maml:Description> <maml:para>Contains the Lab object that was loaded by the Get-Lab object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>An optional array of MSU names.</maml:para> <maml:para>Only MSU Resources matching names in this list will be pulled into the returned in the array.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Returns an array of LabMSUResource objects</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$Lab = Get-Lab -ConfigPath c:\mylab\config.xml</dev:code> <dev:remarks> <maml:para>$ResourceMSU = Get-LabResourceMSU $Lab Loads a Lab and pulls the array of MSU Resources from it.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LabSwitch</command:name> <command:verb>Get</command:verb> <command:noun>LabSwitch</command:noun> <maml:description> <maml:para>Gets an array of switches from a Lab.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Takes a provided Lab and returns the array of LabSwitch objects required for this Lab. This list is usually passed to Initialize-LabSwitch to configure the switches required for this lab.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-LabSwitch</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Lab</maml:name> <maml:Description> <maml:para>Contains the Lab object that was loaded by the Get-Lab object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>An optional array of Switch names.</maml:para> <maml:para>Only Switches matching names in this list will be pulled into the returned in the array.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Lab</maml:name> <maml:Description> <maml:para>Contains the Lab object that was loaded by the Get-Lab object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>An optional array of Switch names.</maml:para> <maml:para>Only Switches matching names in this list will be pulled into the returned in the array.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Returns an array of LabSwitch objects</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$Lab = Get-Lab -ConfigPath c:\mylab\config.xml</dev:code> <dev:remarks> <maml:para>$Switches = Get-LabSwitch -Lab $Lab Loads a Lab and pulls the array of switches from it.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LabVM</command:name> <command:verb>Get</command:verb> <command:noun>LabVM</command:noun> <maml:description> <maml:para>Gets an Array of LabVM objects from a Lab.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Takes the provided Lab and returns the list of VM objects that will be created in this lab. This list is usually passed to Initialize-LabVM.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-LabVM</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Lab</maml:name> <maml:Description> <maml:para>Contains the Lab Builder Lab object that was loaded by the Get-Lab object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>An optional array of VM names.</maml:para> <maml:para>Only VMs matching names in this list will be returned in the array.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>VMTemplates</maml:name> <maml:Description> <maml:para>Contains the array of LabVMTemplate objects returned by Get-LabVMTemplate from this Lab.</maml:para> <maml:para>If not provided it will attempt to pull the list from the Lab.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">LabVMTemplate[]</command:parameterValue> <dev:type> <maml:name>LabVMTemplate[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>Switches</maml:name> <maml:Description> <maml:para>Contains the array of LabVMSwitch objects returned by Get-LabSwitch from this Lab.</maml:para> <maml:para>If not provided it will attempt to pull the list from the Lab.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">LabSwitch[]</command:parameterValue> <dev:type> <maml:name>LabSwitch[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Lab</maml:name> <maml:Description> <maml:para>Contains the Lab Builder Lab object that was loaded by the Get-Lab object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>An optional array of VM names.</maml:para> <maml:para>Only VMs matching names in this list will be returned in the array.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>VMTemplates</maml:name> <maml:Description> <maml:para>Contains the array of LabVMTemplate objects returned by Get-LabVMTemplate from this Lab.</maml:para> <maml:para>If not provided it will attempt to pull the list from the Lab.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">LabVMTemplate[]</command:parameterValue> <dev:type> <maml:name>LabVMTemplate[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>Switches</maml:name> <maml:Description> <maml:para>Contains the array of LabVMSwitch objects returned by Get-LabSwitch from this Lab.</maml:para> <maml:para>If not provided it will attempt to pull the list from the Lab.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">LabSwitch[]</command:parameterValue> <dev:type> <maml:name>LabSwitch[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Returns an array of LabVM objects</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$Lab = Get-Lab -ConfigPath c:\mylab\config.xml</dev:code> <dev:remarks> <maml:para>$VMTemplates = Get-LabVMTemplate -Lab $Lab $Switches = Get-LabSwitch -Lab $Lab $VMs = Get-LabVM ` -Lab $Lab ` -VMTemplates $VMTemplates ` -Switches $Switches Loads a Lab and pulls the array of VMs from it.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>$Lab = Get-Lab -ConfigPath c:\mylab\config.xml</dev:code> <dev:remarks> <maml:para>$VMs = Get-LabVM -Lab $Lab Loads a Lab and pulls the array of VMs from it.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LabVMTemplate</command:name> <command:verb>Get</command:verb> <command:noun>LabVMTemplate</command:noun> <maml:description> <maml:para>Gets an Array of VM Templates for a Lab.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Takes the provided Lab and returns the list of Virtul Machine template machines that will be used to create the Virtual Machines in this lab.</maml:para> <maml:para>This list is usually passed to Initialize-LabVMTemplate.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-LabVMTemplate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Lab</maml:name> <maml:Description> <maml:para>Contains the Lab object that was loaded by the Get-Lab object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>An optional array of VM Template names.</maml:para> <maml:para>Only VM Templates matching names in this list will be returned in the array.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>VMTemplateVHDs</maml:name> <maml:Description> <maml:para>The array of VMTemplateVHDs pulled from the Lab using Get-LabVMTemplateVHD.</maml:para> <maml:para>If not provided it will attempt to pull the list from the Lab.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">LabVMTemplateVHD[]</command:parameterValue> <dev:type> <maml:name>LabVMTemplateVHD[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Lab</maml:name> <maml:Description> <maml:para>Contains the Lab object that was loaded by the Get-Lab object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>An optional array of VM Template names.</maml:para> <maml:para>Only VM Templates matching names in this list will be returned in the array.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>VMTemplateVHDs</maml:name> <maml:Description> <maml:para>The array of VMTemplateVHDs pulled from the Lab using Get-LabVMTemplateVHD.</maml:para> <maml:para>If not provided it will attempt to pull the list from the Lab.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">LabVMTemplateVHD[]</command:parameterValue> <dev:type> <maml:name>LabVMTemplateVHD[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Returns an array of LabVMTemplate objects</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$Lab = Get-Lab -ConfigPath c:\mylab\config.xml</dev:code> <dev:remarks> <maml:para>$VMTemplates = Get-LabVMTemplate -Lab $Lab Loads a Lab and pulls the array of VMTemplates from it.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-LabVMTemplateVHD</command:name> <command:verb>Get</command:verb> <command:noun>LabVMTemplateVHD</command:noun> <maml:description> <maml:para>Gets an Array of TemplateVHDs for a Lab.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Takes a provided Lab and returns the list of Template Disks that will be used to create the Virtual Machines in this lab. This list is usually passed to Initialize-LabVMTemplateVHD.</maml:para> <maml:para>It will validate the paths to the ISO folder as well as to the ISO files themselves.</maml:para> <maml:para>If any ISO files references can't be found an exception will be thrown.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-LabVMTemplateVHD</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Lab</maml:name> <maml:Description> <maml:para>Contains the Lab object that was loaded by the Get-Lab object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>An optional array of VM Template VHD names.</maml:para> <maml:para>Only VM Template VHDs matching names in this list will be returned in the array.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Lab</maml:name> <maml:Description> <maml:para>Contains the Lab object that was loaded by the Get-Lab object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>An optional array of VM Template VHD names.</maml:para> <maml:para>Only VM Template VHDs matching names in this list will be returned in the array.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Returns an array of LabVMTemplateVHD objects</maml:name> </dev:type> <maml:description> <maml:para>It will return Null if the TemplateVHDs node does not exist or contains no TemplateVHD nodes</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$Lab = Get-Lab -ConfigPath c:\mylab\config.xml</dev:code> <dev:remarks> <maml:para>$VMTemplateVHDs = Get-LabVMTemplateVHD -Lab $Lab Loads a Lab and pulls the array of TemplateVHDs from it.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-LabResourceISO</command:name> <command:verb>Initialize</command:verb> <command:noun>LabResourceISO</command:noun> <maml:description> <maml:para>Downloads the Resource ISO packages from a provided array.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Takes an array of LabResourceISO objects and ensures the MSU packages are available in the Lab Resources folder. If they are not they will be downloaded.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-LabResourceISO</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Lab</maml:name> <maml:Description> <maml:para>Contains Lab object that was loaded by the Get-Lab object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>An optional array of ISO packages names.</maml:para> <maml:para>Only ISO packages matching names in this list will be pulled into the returned in the array.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>ResourceISOs</maml:name> <maml:Description> <maml:para>The array of ResourceISO objects pulled from the Lab using Get-LabResourceISO.</maml:para> <maml:para>If not provided it will attempt to pull the list from the Lab.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">LabResourceISO[]</command:parameterValue> <dev:type> <maml:name>LabResourceISO[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Lab</maml:name> <maml:Description> <maml:para>Contains Lab object that was loaded by the Get-Lab object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>An optional array of ISO packages names.</maml:para> <maml:para>Only ISO packages matching names in this list will be pulled into the returned in the array.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>ResourceISOs</maml:name> <maml:Description> <maml:para>The array of ResourceISO objects pulled from the Lab using Get-LabResourceISO.</maml:para> <maml:para>If not provided it will attempt to pull the list from the Lab.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">LabResourceISO[]</command:parameterValue> <dev:type> <maml:name>LabResourceISO[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$Lab = Get-Lab -ConfigPath c:\mylab\config.xml</dev:code> <dev:remarks> <maml:para>$ResourceISOs = Get-LabResourceISO -Lab $Lab Initialize-LabResourceISO -Lab $Lab -ResourceISOs $ResourceISOs Initializes the Resource ISOs in the configured in the Lab c:\mylab\config.xml</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>$Lab = Get-Lab -ConfigPath c:\mylab\config.xml</dev:code> <dev:remarks> <maml:para>Initialize-LabResourceISO -Lab $Lab Initializes the Resource ISOs in the configured in the Lab c:\mylab\config.xml</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-LabResourceModule</command:name> <command:verb>Initialize</command:verb> <command:noun>LabResourceModule</command:noun> <maml:description> <maml:para>Downloads the Resource Modules from a provided array.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Takes an array of LabResourceModule objects ane ensures the Resource Modules are available in the PowerShell Modules folder. If they are not they will be downloaded.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-LabResourceModule</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Lab</maml:name> <maml:Description> <maml:para>Contains Lab object that was loaded by the Get-Lab object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>An optional array of Module names.</maml:para> <maml:para>Only Module Resources matching names in this list will be pulled into the returned in the array.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>ResourceModules</maml:name> <maml:Description> <maml:para>The array of Resource Modules pulled from the Lab using Get-LabResourceModule.</maml:para> <maml:para>If not provided it will attempt to pull the list from the Lab.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">LabResourceModule[]</command:parameterValue> <dev:type> <maml:name>LabResourceModule[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Lab</maml:name> <maml:Description> <maml:para>Contains Lab object that was loaded by the Get-Lab object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>An optional array of Module names.</maml:para> <maml:para>Only Module Resources matching names in this list will be pulled into the returned in the array.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>ResourceModules</maml:name> <maml:Description> <maml:para>The array of Resource Modules pulled from the Lab using Get-LabResourceModule.</maml:para> <maml:para>If not provided it will attempt to pull the list from the Lab.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">LabResourceModule[]</command:parameterValue> <dev:type> <maml:name>LabResourceModule[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$Lab = Get-Lab -ConfigPath c:\mylab\config.xml</dev:code> <dev:remarks> <maml:para>$ResourceModules = Get-LabResourceModule -Lab $Lab Initialize-LabResourceModule -Lab $Lab -ResourceModules $ResourceModules Initializes the Resource Modules in the configured in the Lab c:\mylab\config.xml</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>$Lab = Get-Lab -ConfigPath c:\mylab\config.xml</dev:code> <dev:remarks> <maml:para>Initialize-LabResourceModule -Lab $Lab Initializes the Resource Modules in the configured in the Lab c:\mylab\config.xml</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-LabResourceMSU</command:name> <command:verb>Initialize</command:verb> <command:noun>LabResourceMSU</command:noun> <maml:description> <maml:para>Downloads the Resource MSU packages from a provided array.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Takes an array of LabResourceMSU objects and ensures the MSU packages are available in the Lab Resources folder. If they are not they will be downloaded.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-LabResourceMSU</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Lab</maml:name> <maml:Description> <maml:para>Contains Lab object that was loaded by the Get-Lab object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>An optional array of MSU packages names.</maml:para> <maml:para>Only MSU packages matching names in this list will be pulled into the returned in the array.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>ResourceMSUs</maml:name> <maml:Description> <maml:para>The array of ResourceMSU objects pulled from the Lab using Get-LabResourceModule.</maml:para> <maml:para>If not provided it will attempt to pull the list from the Lab.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">LabResourceMSU[]</command:parameterValue> <dev:type> <maml:name>LabResourceMSU[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Lab</maml:name> <maml:Description> <maml:para>Contains Lab object that was loaded by the Get-Lab object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>An optional array of MSU packages names.</maml:para> <maml:para>Only MSU packages matching names in this list will be pulled into the returned in the array.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>ResourceMSUs</maml:name> <maml:Description> <maml:para>The array of ResourceMSU objects pulled from the Lab using Get-LabResourceModule.</maml:para> <maml:para>If not provided it will attempt to pull the list from the Lab.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">LabResourceMSU[]</command:parameterValue> <dev:type> <maml:name>LabResourceMSU[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$Lab = Get-Lab -ConfigPath c:\mylab\config.xml</dev:code> <dev:remarks> <maml:para>$ResourceMSUs = Get-LabResourceMSU -Lab $Lab Initialize-LabResourceMSU -Lab $Lab -ResourceMSUs $ResourceMSUs Initializes the Resource MSUs in the configured in the Lab c:\mylab\config.xml</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>$Lab = Get-Lab -ConfigPath c:\mylab\config.xml</dev:code> <dev:remarks> <maml:para>Initialize-LabResourceMSU -Lab $Lab Initializes the Resource MSUs in the configured in the Lab c:\mylab\config.xml</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-LabSwitch</command:name> <command:verb>Initialize</command:verb> <command:noun>LabSwitch</command:noun> <maml:description> <maml:para>Creates Hyper-V Virtual Switches from a provided array of LabSwitch objects.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Takes an array of LabSwitch objectsthat were pulled from a Lab object by calling Get-LabSwitch and ensures that they Hyper-V Virtual Switches on the system are configured to match.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-LabSwitch</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Lab</maml:name> <maml:Description> <maml:para>Contains Lab object that was loaded by the Get-Lab object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>An optional array of Switch names.</maml:para> <maml:para>Only Switches matching names in this list will be initialized.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Switches</maml:name> <maml:Description> <maml:para>The array of LabSwitch objects pulled from the Lab using Get-LabSwitch.</maml:para> <maml:para>If not provided it will attempt to pull the array from the Lab object provided.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">LabSwitch[]</command:parameterValue> <dev:type> <maml:name>LabSwitch[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Lab</maml:name> <maml:Description> <maml:para>Contains Lab object that was loaded by the Get-Lab object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>An optional array of Switch names.</maml:para> <maml:para>Only Switches matching names in this list will be initialized.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Switches</maml:name> <maml:Description> <maml:para>The array of LabSwitch objects pulled from the Lab using Get-LabSwitch.</maml:para> <maml:para>If not provided it will attempt to pull the array from the Lab object provided.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">LabSwitch[]</command:parameterValue> <dev:type> <maml:name>LabSwitch[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$Lab = Get-Lab -ConfigPath c:\mylab\config.xml</dev:code> <dev:remarks> <maml:para>$Switches = Get-LabSwitch -Lab $Lab Initialize-LabSwitch -Lab $Lab -Switches $Switches Initializes the Hyper-V switches in the configured in the Lab c:\mylab\config.xml</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>$Lab = Get-Lab -ConfigPath c:\mylab\config.xml</dev:code> <dev:remarks> <maml:para>Initialize-LabSwitch -Lab $Lab Initializes the Hyper-V switches in the configured in the Lab c:\mylab\config.xml</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-LabVM</command:name> <command:verb>Initialize</command:verb> <command:noun>LabVM</command:noun> <maml:description> <maml:para>Initializes the Virtual Machines used by a Lab from a provided array.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Takes an array of LabVM objects that were configured in the Lab.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-LabVM</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Lab</maml:name> <maml:Description> <maml:para>Contains the Lab object that was loaded by the Get-Lab object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>An optional array of VM names.</maml:para> <maml:para>Only VMs matching names in this list will be initialized.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>VMs</maml:name> <maml:Description> <maml:para>An array of LabVM objects pulled from a Lab object.</maml:para> <maml:para>If not provided it will attempt to pull the list from the Lab object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">LabVM[]</command:parameterValue> <dev:type> <maml:name>LabVM[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Lab</maml:name> <maml:Description> <maml:para>Contains the Lab object that was loaded by the Get-Lab object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>An optional array of VM names.</maml:para> <maml:para>Only VMs matching names in this list will be initialized.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>VMs</maml:name> <maml:Description> <maml:para>An array of LabVM objects pulled from a Lab object.</maml:para> <maml:para>If not provided it will attempt to pull the list from the Lab object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">LabVM[]</command:parameterValue> <dev:type> <maml:name>LabVM[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$Lab = Get-Lab -ConfigPath c:\mylab\config.xml</dev:code> <dev:remarks> <maml:para>$VMs = Get-LabVs -Lab $Lab Initialize-LabVM ` -Lab $Lab ` -VMs $VMs Initializes the Virtual Machines in the configured in the Lab c:\mylab\config.xml</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>$Lab = Get-Lab -ConfigPath c:\mylab\config.xml</dev:code> <dev:remarks> <maml:para>Initialize-LabVMs -Lab $Lab Initializes the Virtual Machines in the configured in the Lab c:\mylab\config.xml</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-LabVMTemplate</command:name> <command:verb>Initialize</command:verb> <command:noun>LabVMTemplate</command:noun> <maml:description> <maml:para>{{Fill in the Synopsis}}</maml:para> </maml:description> </command:details> <maml:description> <maml:para>{{Fill in the Description}}</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-LabVMTemplate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Lab</maml:name> <maml:Description> <maml:para>{{Fill Lab Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>{{Fill Name Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>VMTemplates</maml:name> <maml:Description> <maml:para>{{Fill VMTemplates Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">LabVMTemplate[]</command:parameterValue> <dev:type> <maml:name>LabVMTemplate[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>VMTemplateVHDs</maml:name> <maml:Description> <maml:para>{{Fill VMTemplateVHDs Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">LabVMTemplateVHD[]</command:parameterValue> <dev:type> <maml:name>LabVMTemplateVHD[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Lab</maml:name> <maml:Description> <maml:para>{{Fill Lab Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>{{Fill Name Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>VMTemplateVHDs</maml:name> <maml:Description> <maml:para>{{Fill VMTemplateVHDs Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">LabVMTemplateVHD[]</command:parameterValue> <dev:type> <maml:name>LabVMTemplateVHD[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>VMTemplates</maml:name> <maml:Description> <maml:para>{{Fill VMTemplates Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">LabVMTemplate[]</command:parameterValue> <dev:type> <maml:name>LabVMTemplate[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> {{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-LabVMTemplateVHD</command:name> <command:verb>Initialize</command:verb> <command:noun>LabVMTemplateVHD</command:noun> <maml:description> <maml:para>Scans through an array of LabVMTemplateVHD objects and creates them from the ISO if missing.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This function will take an array of LabVMTemplateVHD objects from a Lab or it will extract the arrays itself if it is not provided and ensure that each VHD file is available.</maml:para> <maml:para>If the VHD file is not available then it will attempt to create it from the ISO.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-LabVMTemplateVHD</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Lab</maml:name> <maml:Description> <maml:para>Contains the Lab object that was loaded by the Get-Lab object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>An optional array of VM Template VHD names.</maml:para> <maml:para>Only VM Template VHDs matching names in this list will be initialized.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>VMTemplateVHDs</maml:name> <maml:Description> <maml:para>The array of LabVMTemplateVHD objects pulled from the Lab using Get-LabVMTemplateVHD</maml:para> <maml:para>If not provided it will attempt to pull the list from the Lab.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">LabVMTemplateVHD[]</command:parameterValue> <dev:type> <maml:name>LabVMTemplateVHD[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Lab</maml:name> <maml:Description> <maml:para>Contains the Lab object that was loaded by the Get-Lab object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>An optional array of VM Template VHD names.</maml:para> <maml:para>Only VM Template VHDs matching names in this list will be initialized.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>VMTemplateVHDs</maml:name> <maml:Description> <maml:para>The array of LabVMTemplateVHD objects pulled from the Lab using Get-LabVMTemplateVHD</maml:para> <maml:para>If not provided it will attempt to pull the list from the Lab.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">LabVMTemplateVHD[]</command:parameterValue> <dev:type> <maml:name>LabVMTemplateVHD[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$Lab = Get-Lab -ConfigPath c:\mylab\config.xml</dev:code> <dev:remarks> <maml:para>$VMTemplateVHDs = Get-LabVMTemplateVHD -Lab $Lab Initialize-LabVMTemplateVHD -Lab $Lab -VMTemplateVHDs $VMTemplateVHDs Loads a Lab and pulls the array of VM Template VHDs from it and then ensures all the VHDs are available.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>$Lab = Get-Lab -ConfigPath c:\mylab\config.xml</dev:code> <dev:remarks> <maml:para>Initialize-LabVMTemplateVHD -Lab $Lab Loads a Lab and then ensures VM Template VHDs all the VHDs are available.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Install-Lab</command:name> <command:verb>Install</command:verb> <command:noun>Lab</command:noun> <maml:description> <maml:para>Installs or Update a Lab.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet will install an entire Hyper-V lab environment defined by the LabBuilder configuration file provided.</maml:para> <maml:para>If components of the Lab already exist, they will be updated if they differ from the settings in the Configuration file.</maml:para> <maml:para>The Hyper-V component can also be optionally installed if it is not.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Install-Lab</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ConfigPath</maml:name> <maml:Description> <maml:para>The path to the LabBuilder configuration XML file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>LabPath</maml:name> <maml:Description> <maml:para>The optional path to install the Lab to - overrides the LabPath setting in the configuration file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>CheckEnvironment</maml:name> <maml:Description> <maml:para>Whether or not to check if Hyper-V is installed and install it if missing.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>This will force the Lab to be installed, automatically suppressing any confirmations.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>OffLine</maml:name> <maml:Description> <maml:para>{{Fill OffLine Description}}</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Install-Lab</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="4" aliases="none"> <maml:name>Lab</maml:name> <maml:Description> <maml:para>The Lab object returned by Get-Lab of the lab to install.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>CheckEnvironment</maml:name> <maml:Description> <maml:para>Whether or not to check if Hyper-V is installed and install it if missing.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>This will force the Lab to be installed, automatically suppressing any confirmations.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>OffLine</maml:name> <maml:Description> <maml:para>{{Fill OffLine Description}}</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ConfigPath</maml:name> <maml:Description> <maml:para>The path to the LabBuilder configuration XML file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>LabPath</maml:name> <maml:Description> <maml:para>The optional path to install the Lab to - overrides the LabPath setting in the configuration file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="4" aliases="none"> <maml:name>Lab</maml:name> <maml:Description> <maml:para>The Lab object returned by Get-Lab of the lab to install.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>CheckEnvironment</maml:name> <maml:Description> <maml:para>Whether or not to check if Hyper-V is installed and install it if missing.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>This will force the Lab to be installed, automatically suppressing any confirmations.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>OffLine</maml:name> <maml:Description> <maml:para>{{Fill OffLine Description}}</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Install-Lab -ConfigPath c:\mylab\config.xml</dev:code> <dev:remarks> <maml:para>Install the lab defined in the c:\mylab\config.xml LabBuilder configuration file.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-Lab -ConfigPath c:\mylab\config.xml | Install-Lab</dev:code> <dev:remarks> <maml:para>Install the lab defined in the c:\mylab\config.xml LabBuilder configuration file.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Install-LabVM</command:name> <command:verb>Install</command:verb> <command:noun>LabVM</command:noun> <maml:description> <maml:para>Starts a Lab VM and ensures it has been Initialized.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet is used to start up a Lab VM for the first time.</maml:para> <maml:para>It will start the VM if it is off.</maml:para> <maml:para>If the VM is a Server OS or Nano Server then it will also perform an initial setup:</maml:para> <maml:para> - It will ensure that initial setup has been completed and a self-signed certificate has been created by the VM and downloaded to the LabBuilder folder.</maml:para> <maml:para> - It will also ensure DSC is configured for the VM.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Install-LabVM</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Lab</maml:name> <maml:Description> <maml:para>{{Fill Lab Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>VM</maml:name> <maml:Description> <maml:para>The LabVM Object referring to the VM to start to.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">LabVM</command:parameterValue> <dev:type> <maml:name>LabVM</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Lab</maml:name> <maml:Description> <maml:para>{{Fill Lab Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>VM</maml:name> <maml:Description> <maml:para>The LabVM Object referring to the VM to start to.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">LabVM</command:parameterValue> <dev:type> <maml:name>LabVM</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$Lab = Get-Lab -ConfigPath c:\mylab\config.xml</dev:code> <dev:remarks> <maml:para>$VMs = Get-LabVM -Lab $Lab $Session = Install-LabVM -VM $VMs[0] Start up the first VM in the Lab c:\mylab\config.xml and initialize it.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-Lab</command:name> <command:verb>New</command:verb> <command:noun>Lab</command:noun> <maml:description> <maml:para>Creates a new Lab Builder Configuration file and Lab folder.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This function will take a path to a new Lab folder and a path or filename for a new Lab Configuration file and creates them using the standard XML template.</maml:para> <maml:para>It will also copy the DSCLibrary folder as well as the create an empty ISOFiles and VHDFiles folder in the Lab folder.</maml:para> <maml:para>After running this function the VMs, VMTemplates, Switches and VMTemplateVHDs in the new Lab Configuration file would normally be customized to for the new Lab.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-Lab</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ConfigPath</maml:name> <maml:Description> <maml:para>This is the path to the Lab Builder configuration file to create. If it is not rooted the configuration file is created in the LabPath folder.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>LabPath</maml:name> <maml:Description> <maml:para>This is a required path of the new Lab to create.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>This is a required name of the Lab that gets added to the new Lab Configration file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>Version</maml:name> <maml:Description> <maml:para>This is a required version of the Lab that gets added to the new Lab Configration file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1.0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>This is the optional Lab Id that gets set in the new Lab Configuration file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>This is the optional Lab description that gets set in the new Lab Configuration file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="8" aliases="none"> <maml:name>DomainName</maml:name> <maml:Description> <maml:para>This is the optional Lab domain name that gets set in the new Lab Configuration file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="9" aliases="none"> <maml:name>Email</maml:name> <maml:Description> <maml:para>This is the optional Lab email address that gets set in the new Lab Configuration file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ConfigPath</maml:name> <maml:Description> <maml:para>This is the path to the Lab Builder configuration file to create. If it is not rooted the configuration file is created in the LabPath folder.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>LabPath</maml:name> <maml:Description> <maml:para>This is a required path of the new Lab to create.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>This is a required name of the Lab that gets added to the new Lab Configration file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>Version</maml:name> <maml:Description> <maml:para>This is a required version of the Lab that gets added to the new Lab Configration file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1.0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>This is the optional Lab Id that gets set in the new Lab Configuration file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>This is the optional Lab description that gets set in the new Lab Configuration file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="8" aliases="none"> <maml:name>DomainName</maml:name> <maml:Description> <maml:para>This is the optional Lab domain name that gets set in the new Lab Configuration file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="9" aliases="none"> <maml:name>Email</maml:name> <maml:Description> <maml:para>This is the optional Lab email address that gets set in the new Lab Configuration file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>The Lab object representing the new Lab Configuration that was created</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$MyLab = New-Lab `</dev:code> <dev:remarks> <maml:para>-ConfigPath c:\MyLab\LabConfig1.xml ` -LabPath c:\MyLab ` -LabName 'MyLab' ` -LabVersion '1.2' Creates a new Lab Configration file LabConfig1.xml and also a Lab folder c:\MyLab and populates it with default DSCLibrary file and supporting folders.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-LabSwitch</command:name> <command:verb>Remove</command:verb> <command:noun>LabSwitch</command:noun> <maml:description> <maml:para>Removes all Hyper-V Virtual Switches provided.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet is used to remove any Hyper-V Virtual Switches that were created by the Initialize-LabSwitch cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-LabSwitch</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Lab</maml:name> <maml:Description> <maml:para>Contains the Lab object that was loaded by the Get-Lab object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>An optional array of Switch names.</maml:para> <maml:para>Only Switches matching names in this list will be removed.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Switches</maml:name> <maml:Description> <maml:para>The array of LabSwitch objects pulled from the Lab using Get-LabSwitch.</maml:para> <maml:para>If not provided it will attempt to pull the array from the Lab object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">LabSwitch[]</command:parameterValue> <dev:type> <maml:name>LabSwitch[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>RemoveExternal</maml:name> <maml:Description> <maml:para>By default, external switches will not be removed. Using this switch will allow External switches to be deleted by the function.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Lab</maml:name> <maml:Description> <maml:para>Contains the Lab object that was loaded by the Get-Lab object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>An optional array of Switch names.</maml:para> <maml:para>Only Switches matching names in this list will be removed.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Switches</maml:name> <maml:Description> <maml:para>The array of LabSwitch objects pulled from the Lab using Get-LabSwitch.</maml:para> <maml:para>If not provided it will attempt to pull the array from the Lab object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">LabSwitch[]</command:parameterValue> <dev:type> <maml:name>LabSwitch[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>RemoveExternal</maml:name> <maml:Description> <maml:para>By default, external switches will not be removed. Using this switch will allow External switches to be deleted by the function.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$Lab = Get-Lab -ConfigPath c:\mylab\config.xml</dev:code> <dev:remarks> <maml:para>$Switches = Get-LabSwitch -Lab $Lab Remove-LabSwitch -Lab $Lab -Switches $Switches Removes any Hyper-V switches in the configured in the Lab c:\mylab\config.xml</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>$Lab = Get-Lab -ConfigPath c:\mylab\config.xml</dev:code> <dev:remarks> <maml:para>Remove-LabSwitch -Lab $Lab Removes any Hyper-V switches in the configured in the Lab c:\mylab\config.xml</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-LabVM</command:name> <command:verb>Remove</command:verb> <command:noun>LabVM</command:noun> <maml:description> <maml:para>Removes all Lab Virtual Machines.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet is used to remove any Virtual Machines that were created as part of this Lab.</maml:para> <maml:para>It can also optionally delete the folder and all files created as part of this Lab Virutal Machine.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-LabVM</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Lab</maml:name> <maml:Description> <maml:para>Contains the Lab object that was loaded by the Get-Lab object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>An optional array of VM names.</maml:para> <maml:para>Only VMs matching names in this list will be removed.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>VMs</maml:name> <maml:Description> <maml:para>The array of LabVM objects pulled from the Lab using Get-LabVM.</maml:para> <maml:para>If not provided it will attempt to pull the list from the Lab object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">LabVM[]</command:parameterValue> <dev:type> <maml:name>LabVM[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>RemoveVMFolder</maml:name> <maml:Description> <maml:para>Causes the folder created to contain the Virtual Machine in this lab to be deleted.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Lab</maml:name> <maml:Description> <maml:para>Contains the Lab object that was loaded by the Get-Lab object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>An optional array of VM names.</maml:para> <maml:para>Only VMs matching names in this list will be removed.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>VMs</maml:name> <maml:Description> <maml:para>The array of LabVM objects pulled from the Lab using Get-LabVM.</maml:para> <maml:para>If not provided it will attempt to pull the list from the Lab object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">LabVM[]</command:parameterValue> <dev:type> <maml:name>LabVM[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>RemoveVMFolder</maml:name> <maml:Description> <maml:para>Causes the folder created to contain the Virtual Machine in this lab to be deleted.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$Lab = Get-Lab -ConfigPath c:\mylab\config.xml</dev:code> <dev:remarks> <maml:para>$VMTemplates = Get-LabVMTemplate -Lab $Lab $VMs = Get-LabVs -Lab $Lab -VMTemplates $VMTemplates Remove-LabVM -Lab $Lab -VMs $VMs Removes any Virtual Machines configured in the Lab c:\mylab\config.xml</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>$Lab = Get-Lab -ConfigPath c:\mylab\config.xml</dev:code> <dev:remarks> <maml:para>Remove-LabVM -Lab $Lab Removes any Virtual Machines configured in the Lab c:\mylab\config.xml</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-LabVMTemplate</command:name> <command:verb>Remove</command:verb> <command:noun>LabVMTemplate</command:noun> <maml:description> <maml:para>Removes all Lab Virtual Machine Template VHDs.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet is used to remove any Virtual Machine Template VHDs that were copied when creating this Lab.</maml:para> <maml:para>This function should never be run unless the Lab has no Differencing Disks using these Template VHDs or the Lab is being completely removed. Removing these Template VHDs if Lab Virtual Machines are using these templates as differencing disk parents will cause the Lab Virtual Hard Drives to become corrupt.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-LabVMTemplate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Lab</maml:name> <maml:Description> <maml:para>Contains the Lab object that was loaded by the Get-Lab object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>An optional array of VM Template names.</maml:para> <maml:para>Only VM Templates matching names in this list will be removed.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>VMTemplates</maml:name> <maml:Description> <maml:para>The array of LabVMTemplate objects pulled from the Lab using Get-LabVMTemplate.</maml:para> <maml:para>If not provided it will attempt to pull the list from the Lab.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">LabVMTemplate[]</command:parameterValue> <dev:type> <maml:name>LabVMTemplate[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Lab</maml:name> <maml:Description> <maml:para>Contains the Lab object that was loaded by the Get-Lab object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>An optional array of VM Template names.</maml:para> <maml:para>Only VM Templates matching names in this list will be removed.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>VMTemplates</maml:name> <maml:Description> <maml:para>The array of LabVMTemplate objects pulled from the Lab using Get-LabVMTemplate.</maml:para> <maml:para>If not provided it will attempt to pull the list from the Lab.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">LabVMTemplate[]</command:parameterValue> <dev:type> <maml:name>LabVMTemplate[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$Lab = Get-Lab -ConfigPath c:\mylab\config.xml</dev:code> <dev:remarks> <maml:para>$VMTemplates = Get-LabVMTemplate -Lab $Lab Remove-LabVMTemplate -Lab $Lab -VMTemplates $VMTemplates Removes any Virtual Machine template VHDs configured in the Lab c:\mylab\config.xml</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>$Lab = Get-Lab -ConfigPath c:\mylab\config.xml</dev:code> <dev:remarks> <maml:para>Remove-LabVMTemplate -Lab $Lab Removes any Virtual Machine template VHDs configured in the Lab c:\mylab\config.xml</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-LabVMTemplateVHD</command:name> <command:verb>Remove</command:verb> <command:noun>LabVMTemplateVHD</command:noun> <maml:description> <maml:para>Scans through an array of LabVMTemplateVHD objects and removes them if they exist.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This function will take an array of LabVMTemplateVHD objects from a Lab or it will extract the list itself if it is not provided and remove the VHD file if it exists.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-LabVMTemplateVHD</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Lab</maml:name> <maml:Description> <maml:para>Contains the Lab object that was loaded by the Get-Lab object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>An optional array of VM Template VHD names.</maml:para> <maml:para>Only VM Template VHDs matching names in this list will be removed.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>VMTemplateVHDs</maml:name> <maml:Description> <maml:para>The array of LabVMTemplateVHD objects from the Lab using Get-LabVMTemplateVHD.</maml:para> <maml:para>If not provided it will attempt to pull the list from the Lab.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">LabVMTemplateVHD[]</command:parameterValue> <dev:type> <maml:name>LabVMTemplateVHD[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Lab</maml:name> <maml:Description> <maml:para>Contains the Lab object that was loaded by the Get-Lab object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>An optional array of VM Template VHD names.</maml:para> <maml:para>Only VM Template VHDs matching names in this list will be removed.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>VMTemplateVHDs</maml:name> <maml:Description> <maml:para>The array of LabVMTemplateVHD objects from the Lab using Get-LabVMTemplateVHD.</maml:para> <maml:para>If not provided it will attempt to pull the list from the Lab.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">LabVMTemplateVHD[]</command:parameterValue> <dev:type> <maml:name>LabVMTemplateVHD[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$Lab = Get-Lab -ConfigPath c:\mylab\config.xml</dev:code> <dev:remarks> <maml:para>$VMTemplateVHDs = Get-LabVMTemplateVHD -Lab $Lab Remove-LabVMTemplateVHD -Lab $Lab -VMTemplateVHDs $VMTemplateVHDs Loads a Lab and pulls the array of VM Template VHDs from it and then ensures all the VM template VHDs are deleted.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>$Lab = Get-Lab -ConfigPath c:\mylab\config.xml</dev:code> <dev:remarks> <maml:para>Remove-LabVMTemplateVHD -Lab $Lab Loads a Lab and then ensures the VM template VHDs are deleted.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Start-Lab</command:name> <command:verb>Start</command:verb> <command:noun>Lab</command:noun> <maml:description> <maml:para>Starts an existing Lab.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet will start all the Hyper-V virtual machines definied in a Lab configuration.</maml:para> <maml:para>It will use the Bootorder attribute (if defined) for any VMs to determine the order they should be booted in. If a Bootorder is not specified for a machine, it will be booted after all machines with a defined boot order.</maml:para> <maml:para>The lower the Bootorder value for a machine the earlier it will be started in the start process.</maml:para> <maml:para>Machines will be booted in series, with each machine starting once the previous machine has completed startup and has a management IP address.</maml:para> <maml:para>If a Virtual Machine in the Lab is already running, it will be ignored and the next machine in series will be started.</maml:para> <maml:para>If more than one Virtual Machine shares the same Bootorder value, then these machines will be booted in parallel, with the boot process only continuing onto the next Bootorder when all these machines are booted.</maml:para> <maml:para>If a Virtual Machine specified in the configuration is not found an exception will be thrown.</maml:para> <maml:para>If a Virtual Machine takes longer than the StartupTimeout then an exception will be thown but the Start process will continue.</maml:para> <maml:para>If a Bootorder of 0 is specifed then the Virtual Machine will not be booted at all. This is useful for things like Root CA VMs that only need to started when the Lab is created.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-Lab</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ConfigPath</maml:name> <maml:Description> <maml:para>The path to the LabBuilder configuration XML file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>LabPath</maml:name> <maml:Description> <maml:para>The optional path to install the Lab to - overrides the LabPath setting in the configuration file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>StartupTimeout</maml:name> <maml:Description> <maml:para>The maximum number of seconds that the process will wait for a VM to startup. Defaults to 90 seconds.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Script:StartupTimeout</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Start-Lab</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="4" aliases="none"> <maml:name>Lab</maml:name> <maml:Description> <maml:para>The Lab object returned by Get-Lab of the lab to start.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>StartupTimeout</maml:name> <maml:Description> <maml:para>The maximum number of seconds that the process will wait for a VM to startup. Defaults to 90 seconds.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Script:StartupTimeout</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ConfigPath</maml:name> <maml:Description> <maml:para>The path to the LabBuilder configuration XML file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>LabPath</maml:name> <maml:Description> <maml:para>The optional path to install the Lab to - overrides the LabPath setting in the configuration file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="4" aliases="none"> <maml:name>Lab</maml:name> <maml:Description> <maml:para>The Lab object returned by Get-Lab of the lab to start.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>StartupTimeout</maml:name> <maml:Description> <maml:para>The maximum number of seconds that the process will wait for a VM to startup. Defaults to 90 seconds.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Script:StartupTimeout</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Start-Lab -ConfigPath c:\mylab\config.xml</dev:code> <dev:remarks> <maml:para>Start the lab defined in the c:\mylab\config.xml LabBuilder configuration file.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-Lab -ConfigPath c:\mylab\config.xml | Start-Lab</dev:code> <dev:remarks> <maml:para>Start the lab defined in the c:\mylab\config.xml LabBuilder configuration file.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Stop-Lab</command:name> <command:verb>Stop</command:verb> <command:noun>Lab</command:noun> <maml:description> <maml:para>Stop an existing Lab.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet will stop all the Hyper-V virtual machines definied in a Lab configuration.</maml:para> <maml:para>It will use the Bootorder attribute (if defined) for any VMs to determine the order they should be shutdown in. If a Bootorder is not specified for a machine, it will be shutdown before all machines with a defined boot order.</maml:para> <maml:para>The higher the Bootorder value for a machine the earlier it will be shutdown in the stop process.</maml:para> <maml:para>The Virtual Machines will be shutdown in REVERSE Bootorder.</maml:para> <maml:para>Machines will be shutdown in series, with each machine shutting down once the previous machine has completed shutdown.</maml:para> <maml:para>If a Virtual Machine in the Lab is already shutdown, it will be ignored and the next machine in series will be shutdown.</maml:para> <maml:para>If more than one Virtual Machine shares the same Bootorder value, then these machines will be shutdown in parallel, with the shutdown process only continuing onto the next Bootorder when all these machines are shutdown.</maml:para> <maml:para>If a Virtual Machine specified in the configuration is not found an exception will be thrown.</maml:para> <maml:para>If a Virtual Machine takes longer than the ShutdownTimeout then an exception will be thown but the Stop process will continue.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Stop-Lab</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ConfigPath</maml:name> <maml:Description> <maml:para>The path to the LabBuilder configuration XML file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>LabPath</maml:name> <maml:Description> <maml:para>The optional path to install the Lab to - overrides the LabPath setting in the configuration file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Stop-Lab</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="4" aliases="none"> <maml:name>Lab</maml:name> <maml:Description> <maml:para>The Lab object returned by Get-Lab of the lab to start.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ConfigPath</maml:name> <maml:Description> <maml:para>The path to the LabBuilder configuration XML file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>LabPath</maml:name> <maml:Description> <maml:para>The optional path to install the Lab to - overrides the LabPath setting in the configuration file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="4" aliases="none"> <maml:name>Lab</maml:name> <maml:Description> <maml:para>The Lab object returned by Get-Lab of the lab to start.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Stop-Lab -ConfigPath c:\mylab\config.xml</dev:code> <dev:remarks> <maml:para>Stop the lab defined in the c:\mylab\config.xml LabBuilder configuration file.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-Lab -ConfigPath c:\mylab\config.xml | Stop-Lab</dev:code> <dev:remarks> <maml:para>Stop the lab defined in the c:\mylab\config.xml LabBuilder configuration file.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Uninstall-Lab</command:name> <command:verb>Uninstall</command:verb> <command:noun>Lab</command:noun> <maml:description> <maml:para>Uninstall the components of an existing Lab.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This function will attempt to remove the components of the lab specified in the provided LabBuilder configuration file.</maml:para> <maml:para>It will always remove any Lab Virtual Machines, but can also optionally remove: Switches VM Templates VM Template VHDs</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Uninstall-Lab</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ConfigPath</maml:name> <maml:Description> <maml:para>The path to the LabBuilder configuration XML file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>LabPath</maml:name> <maml:Description> <maml:para>The optional path to uninstall the Lab from - overrides the LabPath setting in the configuration file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>RemoveSwitch</maml:name> <maml:Description> <maml:para>Causes the switches defined by this to be removed.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>RemoveVMTemplate</maml:name> <maml:Description> <maml:para>Causes the VM Templates created by this to be be removed.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>RemoveVMFolder</maml:name> <maml:Description> <maml:para>Causes the VM folder created to contain the files for any the VMs in this Lab to be removed.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="8" aliases="none"> <maml:name>RemoveVMTemplateVHD</maml:name> <maml:Description> <maml:para>Causes the VM Template VHDs that are used in this lab to be deleted.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="9" aliases="none"> <maml:name>RemoveLabFolder</maml:name> <maml:Description> <maml:para>Causes the entire folder containing this Lab to be deleted.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Uninstall-Lab</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="4" aliases="none"> <maml:name>Lab</maml:name> <maml:Description> <maml:para>The Lab object returned by Get-Lab of the lab to uninstall.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>RemoveSwitch</maml:name> <maml:Description> <maml:para>Causes the switches defined by this to be removed.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>RemoveVMTemplate</maml:name> <maml:Description> <maml:para>Causes the VM Templates created by this to be be removed.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>RemoveVMFolder</maml:name> <maml:Description> <maml:para>Causes the VM folder created to contain the files for any the VMs in this Lab to be removed.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="8" aliases="none"> <maml:name>RemoveVMTemplateVHD</maml:name> <maml:Description> <maml:para>Causes the VM Template VHDs that are used in this lab to be deleted.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="9" aliases="none"> <maml:name>RemoveLabFolder</maml:name> <maml:Description> <maml:para>Causes the entire folder containing this Lab to be deleted.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ConfigPath</maml:name> <maml:Description> <maml:para>The path to the LabBuilder configuration XML file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>LabPath</maml:name> <maml:Description> <maml:para>The optional path to uninstall the Lab from - overrides the LabPath setting in the configuration file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="4" aliases="none"> <maml:name>Lab</maml:name> <maml:Description> <maml:para>The Lab object returned by Get-Lab of the lab to uninstall.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>RemoveSwitch</maml:name> <maml:Description> <maml:para>Causes the switches defined by this to be removed.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>RemoveVMTemplate</maml:name> <maml:Description> <maml:para>Causes the VM Templates created by this to be be removed.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>RemoveVMFolder</maml:name> <maml:Description> <maml:para>Causes the VM folder created to contain the files for any the VMs in this Lab to be removed.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="8" aliases="none"> <maml:name>RemoveVMTemplateVHD</maml:name> <maml:Description> <maml:para>Causes the VM Template VHDs that are used in this lab to be deleted.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="9" aliases="none"> <maml:name>RemoveLabFolder</maml:name> <maml:Description> <maml:para>Causes the entire folder containing this Lab to be deleted.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Uninstall-Lab `</dev:code> <dev:remarks> <maml:para>-ConfigPath c:\mylab\config.xml ` -RemoveSwitch` -RemoveVMTemplate ` -RemoveVMFolder ` -RemoveVMTemplateVHD ` -RemoveLabFolder Completely uninstall all components in the lab defined in the c:\mylab\config.xml LabBuilder configuration file.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-Lab -ConfigPath c:\mylab\config.xml | Uninstall-Lab `</dev:code> <dev:remarks> <maml:para>-RemoveSwitch` -RemoveVMTemplate ` -RemoveVMFolder ` -RemoveVMTemplateVHD ` -RemoveLabFolder Completely uninstall all components in the lab defined in the c:\mylab\config.xml LabBuilder configuration file.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-Lab</command:name> <command:verb>Update</command:verb> <command:noun>Lab</command:noun> <maml:description> <maml:para>Update a Lab.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet will update the existing Hyper-V lab environment defined by the LabBuilder configuration file provided.</maml:para> <maml:para>If components of the Lab are missing they will be added.</maml:para> <maml:para>If components of the Lab already exist, they will be updated if they differ from the settings in the Configuration file.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-Lab</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ConfigPath</maml:name> <maml:Description> <maml:para>The path to the LabBuilder configuration XML file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>LabPath</maml:name> <maml:Description> <maml:para>The optional path to update the Lab in - overrides the LabPath setting in the configuration file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-Lab</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="4" aliases="none"> <maml:name>Lab</maml:name> <maml:Description> <maml:para>The Lab object returned by Get-Lab of the lab to update.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ConfigPath</maml:name> <maml:Description> <maml:para>The path to the LabBuilder configuration XML file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>LabPath</maml:name> <maml:Description> <maml:para>The optional path to update the Lab in - overrides the LabPath setting in the configuration file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="4" aliases="none"> <maml:name>Lab</maml:name> <maml:Description> <maml:para>The Lab object returned by Get-Lab of the lab to update.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Update-Lab -ConfigPath c:\mylab\config.xml</dev:code> <dev:remarks> <maml:para>Update the lab defined in the c:\mylab\config.xml LabBuilder configuration file.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-Lab -ConfigPath c:\mylab\config.xml | Update-Lab</dev:code> <dev:remarks> <maml:para>Update the lab defined in the c:\mylab\config.xml LabBuilder configuration file.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> </helpItems> |