v4.17.0

Author: jdhitsolutions

Detailed-Setup-Instructions.md

@@ -4,11 +4,11 @@ Please refer to this document to assist in installing and setting up the `PSAuto
 
 It is also assumed that you have administrator rights to your computer and can makes changes. If your computer is controlled by Group Policy, you may encounter problems. You should also be logged in with a local or domain user account. The setup process may not work properly if using an O365 or Microsoft account to logon to Windows.
 
-> It is *possible* to run this module with nested virtualization inside a Windows 10 Hyper-V virtual machine but it is **not** recommended. Some networking features may not work properly and overall performance will likely be reduced.
+It is *possible* to run this module with nested virtualization inside a Windows 10 Hyper-V virtual machine but it is **not** recommended. Some networking features may not work properly and overall performance will likely be reduced.
 
 ## Pre-Check
 
-TYou can run these commands to verify your computer meets the minimum requirements. Run all PowerShell commands in an elevated session.
+You can run these commands to verify your computer meets the minimum requirements. Run all PowerShell commands in an elevated session.
 
 ### Operating System and Memory
 
@@ -22,7 +22,7 @@ Microsoft Windows 10 Pro    32
 
 If the Caption shows anything other than Pro or Enterprise this module may not work. Although it appears that Windows 10 Education might be supported. In fact, if you can't even open a PowerShell prompt, this module won't work on your computer.
 
-The memory size should be at least 12. 16 or greater is recommended. If the number is less than 12, **STOP**. It is unlikely you have enough installed memory. Depending on the configuration you want to run, it *might* be possible to proceed with less memory. Open an Issue and ask for guidance indicating your memory settings from this command:
+The memory size should be at least 12GB. 16GB or greater is recommended. If the number is less than 12, **STOP**. It is unlikely you have enough installed memory. Depending on the configuration you want to run, it *might* be possible to proceed with less memory. Open an Issue and ask for guidance indicating your memory settings from this command:
 
 ```text
 PS C:\> Get-CimInstance Win32_OperatingSystem | Select-Object FreePhysicalMemory,TotalVisibleMemorySize
@@ -49,8 +49,8 @@ ProductVersion  : OS: 0.0.0 SP: 0.0 Stack: 3.0
 
 This is what you should see as a result. Any errors mean that PowerShell remoting is disabled. Enable it from your **elevated** PowerShell session. This will fail if your only network connection is over a public network.
 
-```text
-PS C:\ Enable-PSRemoting -force
+```powershell
+Enable-PSRemoting -force
 ```
 
 If this fails, **STOP**. Do not proceed with this module until this is working and `Test-WSMan` gives you a result. If you are running as Administrator and this command fails it is most likely because the related settings are controlled by a Group Policy or your network is public. Run `Get-NetConnectionProfile` and look at the NetworkCategory. If must be `Private` or `DomainAuthenticated`.
@@ -68,20 +68,20 @@ D         477     183       38.41 Healthy
 C         237      87       36.71 Healthy
 ```
 
-You should have close to 100GB of free space on a fixed hard drive such as C or D. This module has not been tested running from a externally connected drive.
+You should have close to 100GB of free space on a fixed hard drive such as C or D. The module will setup an Autolab folder on drive C: by default, although you can specify an alternate drive. This module has not been tested running from a externally connected drive.
 
 ### Virtualization
 
-The module requires the Hyper-V feature on Windows 10. Please refer to documentation for your computer to determine if it supports virtualization. You may need to configure settings in your BIOS. You don't need to manually enable the Hyper-V feature now, although you are welcome to if you want to verify it is available.
+The module requires the Hyper-V feature on Windows 10. Please refer to documentation for your computer hardware to determine if it supports virtualization. You may need to configure settings in your BIOS. You don't need to manually enable the Hyper-V feature now, although you are welcome to if you want to verify it is available.
 
 ## Installation and Configuration
 
 ### Install the Module
 
 If you meet the requirements, you are ready to download and install this module. **Do not download anything from this GitHub repository.** In your PowerShell session run this command:
 
-```text
-PS C:\> Install-Module PSAutolab -force -SkipPublisherCheck
+```powershell
+Install-Module PSAutolab -force -SkipPublisherCheck
 ```
 
 You may be prompted to update to a newer version of `nuget`. Answer "yes". You might also be prompted about installing from an untrusted source. Again, you will need to say "yes". After installation you can verify using `Get-Module`.
@@ -94,26 +94,26 @@ PS C:\> Get-Module PSAutoLab -list
 
 ModuleType Version    Name                       ExportedCommands
 ---------- -------    ----                       ----------------
-Script     4.11.0      PSAutoLab                 {Enable-Internet, Invoke-RefreshLab, Invoke-Run...
+Script     4.16.0      PSAutoLab                 {Enable-Internet, Invoke-RefreshLab, Invoke-Run...
 ```
 
 You may see a newer version number than what is indicated here. The `README` file indicates the current version in the PowerShell Gallery.
 
 ### Setup the Host
 
-You have to setup your computer one-time to use this module. In your elevated PowerShell session run this command:
+There is a one-time step to setup your computer for the AutoLab environment. In your elevated PowerShell session run this command:
 
-```text
-PS C:\> Setup-Host
+```powershell
+Setup-Host
 ```
 
 This command will create a directory structure for the module and all of its files. The default is `C:\Autolab` which you should be able to accept. If you are low on space or want to use an alternate drive, then you can specify an alternative top level path.
 
-```text
-PS C:\> Setup-Host -DestinationPath D:\Autolab
+```powershell
+Setup-Host -DestinationPath D:\Autolab
 ```
 
-If you select a drive other than C:\ it is recommended you use the `Autolab` folder name. The setup process will install additional modules and files.  If necessary, it will enable the Hyper-V feature. If Hyper-V is enabled, please reboot your computer before proceeding.
+If you select a drive other than C:\ it is recommended you use the `Autolab` folder name. The setup process will install additional modules and files. If necessary, it will enable the Hyper-V feature. If Hyper-V is enabled during the setup, please reboot your computer before proceeding.
 
 To verify your configuration, run `Get-PSAutolabSetting`.
 
@@ -131,7 +131,7 @@ Processor                   : Intel(R) Core(TM) i7-8750H CPU @ 2.20GHz
 IsElevated                  : True
 RemotingEnabled             : True
 HyperV                      : 10.0.18362.1
-PSAutolab                   : 4.11.0
+PSAutolab                   : 4.16.0
 Lability                    : {0.19.1, 0.19.0, 0.18.0}
 Pester                      : {5.0.2, 4.10.1, 4.9.0, 4.8.1...}
 PowerShellGet               : 2.2.4.1
@@ -145,35 +145,52 @@ If Hyper-V is not installed you will see errors. Any errors indicate a problem w
 In an elevated PowerShell session, **change directory** to the configuration folder that you want to use.
 
 ```text
-PS C:\> cd C:\Autolab\Configurations\SingleServer-GUI-2016\
-PS C:\Autolab\Configurations\SingleServer-GUI-2016>
+PS C:\> cd C:\Autolab\Configurations\SingleServer-GUI-2016
+PS C:\Autolab\Configurations\SingleServer-GUI-2016\>
 ```
 
-You can look at the `instructions.md` file to get more information about the configuration.
+You can look at the `instructions.md` file in the folder to get more information about the configuration.
 
 ```text
-PS C:\Autolab\Configurations\SingleServer-GUI-2016> get-content .\Instructions.md
+PS C:\Autolab\Configurations\SingleServer-GUI-2016\> get-content .\Instructions.md
 ```
 
 Or open the file with Notepad.
 
+Another option is to use the `Get-LabSummary` command. This will show you what computers will be created and how they will be created. The Computername will also be the virtual machine name.
+
+```text
+PS C:\Autolab\Configurations\SingleServer-GUI-2016\> Get-LabSummary
+
+
+Computername : S1
+VMName       : S1
+InstallMedia : 2016_x64_Standard_EN_Eval
+Description  : Windows Server 2016 Standard 64bit English Evaluation
+Role         : RDP
+IPAddress    : 192.168.3.75
+MemoryGB     : 4
+Processors   : 1
+Lab          : SingleServer-GUI-2016
+```
+
 You can run `Unattend-Lab` for a completely hands-free experience.
 
 ```text
-PS C:\Autolab\Configurations\SingleServer-GUI-2016> unattend-lab
+PS C:\Autolab\Configurations\SingleServer-GUI-2016\> unattend-lab
 ```
 
 The very first time you run a setup, the command will download ISO images of evaluation software from Microsoft. These files will be at least 4GB in size. If you are setting up a domain-based configuration, this means you will be downloading ISO images for Windows Server and Windows 10. This download only happens once.
 
 Note that during the validation phase you may see errors. This is to be expected until all of the configurations merge. You can press `Ctrl+C` to break out of the testing. The virtual machines will continue to prepare themselves. Later, you can manually validate the lab:
 
 ```text
-PS C:\Autolab\Configurations\SingleServer-GUI-2016> Invoke-Pester .\vmvalidate.test.ps1
+PS C:\Autolab\Configurations\SingleServer-GUI-2016\> Invoke-Pester .\vmvalidate.test.ps1
 ```
 
 ### Manual Configuration Setup
 
-If you encounter errors running an unattended setup, you should step through the process manually to identify where exactly an error is occurring. Make sure you are in an elevated PowerShell session and you have changed location to the configuration folder. If you have tried to setup the lab before run `Wipe-Lab` to remove previous set up files. Then run each of these commands individually:
+If you encounter errors running an unattended setup, you should step through the process manually to identify where exactly an error is occurring. Make sure you are in an elevated PowerShell session and you have *changed location to the configuration folder*. If you have tried to setup the lab before run `Wipe-Lab` to remove previous set up files. Then run each of these commands individually:
 
 * `Setup-Lab`
 * `Enable-Internet`
@@ -193,15 +210,31 @@ You might still see errors or failures, in which case try again in 10 minute int
 
 All of the commands in this module have help and examples. You are also encouraged to read the about help topic.
 
-```text
-PS C:\> help about_PSAutoLab
+```powershell
+help about_PSAutoLab
 ```
 
 ## Using the Environment Prefix
 
-In the `VMConfigurationData.psd1` file for each lab, you will see a commented out section for an environment prefix value. This value exists for special situations where you might have a virtual machine naming collision or want to be able to identify the virtual machines that belong to the AutoLab module. In a normal setup, the Hyper-V virtual machine name will be the same as the hostname in the VM guest. If the lab creates a guest with a computername of `S1`, the Hyper-V virtual machine will also be called `S1`. If you enable prefix setting, the Hyper-V virtual machine name will use the prefix, **but the guest computer name will not.**  For example, if you enable the default prefix (you can change it to anything you'd like), you will create a Hyper-V virtual machine with a VMName of `Autolab-S1` but the actual computername will still be `S1`. The validation tests will reference the guest computer name, not the Hyper-V virtual machine name.
+In the `VMConfigurationData.psd1` file for each lab, you will see a commented out section for an environment prefix value. This value exists for special situations where you might have a virtual machine naming collision or want to be able to identify the virtual machines that belong to the AutoLab module. In a normal setup and for almost all users, the Hyper-V virtual machine name will be the same as the hostname (computername) in the VM guest. If the lab creates a guest with a computername of `S1`, the Hyper-V virtual machine will also be called `S1`. If you enable the prefix setting, the Hyper-V virtual machine name will use the prefix, **but the guest computer name will not.**  For example, if you enable the default prefix (you can change it to anything you'd like), you will create a Hyper-V virtual machine with a VMName of `Autolab-S1` but the actual computername will still be `S1`. The validation tests will reference the guest computer name, not the Hyper-V virtual machine name.
+
+If you must use this feature, open the `VMConfigurationData.psd1` file in a text or code editor. Scroll down to the `NonNodeData` section.
+
+```powershell
+    NonNodeData = @{
+        Lability = @{
+
+            # You can uncomment this line to add a prefix to the virtual machine name.
+            # It will not change the guest computername
+            # See https://github.com/pluralsight/PS-AutoLab-Env/blob/master/Detailed-Setup-Instructions.md
+            # for more information.
+
+            #EnvironmentPrefix = 'AutoLab-'
+```
+
+Remove the `#` character before `EnvironmentPrefix`. If you want to change the value from `Autolab-` to something else go ahead. The prefix will be inserted before the computername to create the virtual machine name.
 
-This setting should only be used in special situations as it can be confusing. While every effort has been made to ensure compatibility with commands in this module, there is no guarantee of 100% success. Also note that any changes you make to the configuration files could be overwritten in future updates.
+This setting should only be used in special situations as it can be confusing. While every effort has been made to ensure compatibility with commands in this module, there is no guarantee of 100% success. Also note that any changes you make to the configuration files could be overwritten in future updates or when you run `Refresh-Host`.
 
 ## Troubleshooting Tips
 
@@ -223,4 +256,4 @@ Wait about 5 minutes and then test again.
 
 If encounter problems getting any of this to work, you are welcome to post an Issue. If you get the module installed, please include the results of `Get-PSAutolabSetting`. If your problem is meeting one of the requirements, we will do our best to help. Although if your computer is locked down or otherwise controlled by corporate policies there may not be much that we can do.
 
-last updated 2020-06-10 13:54:56Z UTC
+last updated 2020-08-05 17:39:25Z UTC

PSAutoLab.psd1

@@ -14,3 +14,25 @@ $PesterVersion = "4.10.1"
 
 #declare the currently supported version of Lability
 $LabilityVersion = "0.19.1"
+
+#configure TLS protocol to avoid problems downloading files from Microsoft
+[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
+
+#open the PDF help file
+Function Open-PSAutoLabHelp {
+    [cmdletbinding()]
+    Param()
+
+    $pdf = Join-Path -path $PSScriptRoot -ChildPath PSAutoLabManual.pdf
+    if (Test-Path -Path $pdf) {
+        Try {
+            Start-Process -FilePath $pdf -ErrorAction Stop
+        }
+        Catch {
+            Write-Warning "Failed to automatically open the PDF. You will need to manually open $pdf."
+        }
+    }
+    else {
+        Write-Warning "Can't find $pdf."
+    }
+}