Invoke-WipeLab.md

external help file	Module Name	online version	schema
PSAutoLab-help.xml	PSAutoLab	https://github.com/pluralsight/PS-AutoLab-Env/blob/master/docs/Invoke-WipeLab.md	2.0.0

Invoke-WipeLab

SYNOPSIS

Remove an Autolab configuration.

SYNTAX

Invoke-WipeLab [[-Path] <String>] [-RemoveSwitch] [-Force] [-NoMessages] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

You can use this command to remove all files and virtual machines related to an Autolab configuration. The command will stop any running virtual machines for you. It is assumed you will be running this command from within a configuration folder.

If you intend to rebuild the lab or create another configuration, you do not need to delete the virtual switch (LabNet).

Use -Force to suppress all prompts.

You will typically use the Wipe-Lab alias.

EXAMPLES

Example 1

PS C:\AutoLab\Configurations\Windows10> Wipe-Lab

Follow any on-screen prompts or instructions.

Example 2

PS C:\AutoLab\Configurations\SingleServer> Wipe-Lab -force -RemoveSwitch

Forcibly remove all lab elements including the virtual switch.

PARAMETERS

-Path

The path to the configuration folder. Normally, you should run all commands from within the configuration folder.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 0
Default value: Current Directory
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Force

Remove lab elements with no prompting.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-RemoveSwitch

Remove the VM Switch. It is retained by default.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-NoMessages

Run the command but suppress all status messages.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: Quiet

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

None

OUTPUTS

System.Object

NOTES

RELATED LINKS

Setup-Lab