Skip to content
This repository was archived by the owner on Nov 15, 2024. It is now read-only.

Commit 46804d3

Browse files
v4.18.0
1 parent 4ecf31b commit 46804d3

20 files changed

+308
-262
lines changed

Detailed-Setup-Instructions.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Detailed Setup Instructions
22

3-
Please refer to this document to assist in installing and setting up the `PSAutolab` module on your computer. Run all commands from an **elevated** Windows PowerShell session. In other words, *run Windows PowerShell as administrator*. You will know you are elevated if you see the word `Administrator` in the title bar of the PowerShell window. Do NOT run this module in PowerShell 7. It is assumed you are running this on Windows 10 Professional or Enterprise editions.
3+
Please refer to this document to assist in installing and setting up the `PSAutolab` module on your computer. Run all commands from an **elevated** Windows PowerShell session. In other words, *run Windows PowerShell as administrator*. You will know you are elevated if you see the word `Administrator` in the title bar of the PowerShell window. __Do NOT run this module in PowerShell 7__. It is assumed you are running this on Windows 10 Professional or Enterprise editions.
44

55
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.
66

@@ -68,11 +68,11 @@ D 477 183 38.41 Healthy
6868
C 237 87 36.71 Healthy
6969
```
7070

71-
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.
71+
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 an externally connected drive.
7272

7373
### Virtualization
7474

75-
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.
75+
The module requires the Hyper-V feature on Windows 10. Please refer to the 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.
7676

7777
## Installation and Configuration
7878

@@ -107,7 +107,7 @@ There is a one-time step to setup your computer for the AutoLab environment. In
107107
Setup-Host
108108
```
109109

110-
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.
110+
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.
111111

112112
```powershell
113113
Setup-Host -DestinationPath D:\Autolab
@@ -180,7 +180,7 @@ You can run `Unattend-Lab` for a completely hands-free experience.
180180
PS C:\Autolab\Configurations\SingleServer-GUI-2016\> unattend-lab
181181
```
182182

183-
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.
183+
The very first time you setup a lab, 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.
184184

185185
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:
186186

@@ -190,21 +190,21 @@ PS C:\Autolab\Configurations\SingleServer-GUI-2016\> Invoke-Pester .\vmvalidate.
190190

191191
### Manual Configuration Setup
192192

193-
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:
193+
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:
194194

195195
* `Setup-Lab`
196196
* `Enable-Internet`
197197
* `Run-Lab`
198198

199-
Errors that affect setup should happen in one of these steps. If so, open an issue with configuration name, the command you were working on and the error message. Also include the output from `Get-PSAutolabSetting`.
199+
Errors that affect setup should happen in one of these steps. If so, open an issue with the configuration name, the command you were working on and the error message. Also include the output from `Get-PSAutolabSetting`.
200200

201201
After about 10 minutes, you can manually test to see if the configuration has finalized.
202202

203203
```powershell
204204
Invoke-Pester .\vmvalidate.test.ps1
205205
```
206206

207-
You might still see errors or failures, in which case try again in 10 minute intervals until the test completely passes. You might also need to verify that the virtual machine is running using the Hyper-V manager and starting it if it has shutdown.
207+
You might still see errors or failures, in which case try again in 10-minute intervals until the test completely passes. You might also need to verify that the virtual machine is running using the Hyper-V manager and starting it if it has shutdown.
208208

209209
### Help
210210

@@ -216,20 +216,20 @@ help about_PSAutoLab
216216

217217
## Using the Environment Prefix
218218

219-
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.
219+
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 (computer name) in the VM guest. If the lab creates a guest with a computer name 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 computer name will still be `S1`. The validation tests will reference the guest computer name, not the Hyper-V virtual machine name.
220220

221221
If you must use this feature, open the `VMConfigurationData.psd1` file in a text or code editor. Scroll down to the `NonNodeData` section.
222222

223223
```powershell
224-
NonNodeData = @{
225-
Lability = @{
224+
NonNodeData = @{
225+
Lability = @{
226226
227-
# You can uncomment this line to add a prefix to the virtual machine name.
228-
# It will not change the guest computername
229-
# See https://github.com/pluralsight/PS-AutoLab-Env/blob/master/Detailed-Setup-Instructions.md
230-
# for more information.
227+
# You can uncomment this line to add a prefix to the virtual machine name.
228+
# It will not change the guest computer name
229+
# See https://github.com/pluralsight/PS-AutoLab-Env/blob/master/Detailed-Setup-Instructions.md
230+
# for more information.
231231
232-
#EnvironmentPrefix = 'AutoLab-'
232+
#EnvironmentPrefix = 'AutoLab-'
233233
```
234234

235235
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.
@@ -238,7 +238,7 @@ This setting should only be used in special situations as it can be confusing. W
238238

239239
## Troubleshooting Tips
240240

241-
Occasionally, things can go wrong for no apparent reason. If you ran through the manual steps to setup a lab but the validations tests is still failing, you may need to stop and restart the virtual machine that is causing problems. For example, *sometimes* the SRV2 member in the `PowerShellLab` configuration simply won't pass validation, often because it can't be connected to. The best solution is to shut down the virtual machine in either the Hyper-V manager or from PowerShell.
241+
Occasionally, things can go wrong for no apparent reason. If you ran through the manual steps to setup a lab but the validations tests is still failing, you may need to stop and restart the virtual machine that is causing problems. For example, *sometimes* the SRV2 member in the `PowerShellLab` configuration simply won't pass validation, often because it can't be connected to. The best solution is to shut down the virtual machine in either the Hyper-V Manager or from PowerShell.
242242

243243
```powershell
244244
Stop-VM srv2 -force
@@ -256,4 +256,4 @@ Wait about 5 minutes and then test again.
256256

257257
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.
258258

259-
last updated 2020-08-05 17:39:25Z UTC
259+
last updated 2020-10-06 15:37:01Z

PSAutoLab.psd1

68 Bytes
Binary file not shown.

PSAutoLabManual.pdf

-435 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)