Automated PowerShell Implementation of Identity and Access Management

Use the PowerShell Module for VMware Validated Solutions to implement the Identity and Access Management for VMware Cloud Foundation validated solution.

PowerShell Module Installation

If you want to use the open source PowerShell Module for VMware Validated Solutions to automate the implementation of this validated solution, you must first prepare the management host.

Note:

For information on how to install this module, see PowerValidated Solutions.

To report issues, obtain support, or suggest enhancements to the open-source PowerShell Module, use GitHub Issues in the GitHub repository.

Connected Environment

1. Verify that your system has PowerShell 7.2 or later installed. See Microsoft PowerShell.

2. Start PowerShell.

3. Install the PowerShell Module for VMware Validated Solutions together with the supporting modules from the PowerShell Gallery.

   Install-Module -Name VMware.PowerCLI -MinimumVersion 13.3.0 -Scope AllUsers
   Install-Module -Name VMware.vSphere.SsoAdmin -MinimumVersion 1.3.9 -Scope AllUsers
   Install-Module -Name ImportExcel -MinimumVersion 7.8.9 -Scope AllUsers
   Install-Module -Name PowerVCF -MinimumVersion 2.4.0 -Scope AllUsers
   Install-Module -Name PowerValidatedSolutions -MinimumVersion 2.12.0 -Scope AllUsers

4. Import the PowerShell Module for VMware Validated Solutions.

   Import-Module -Name PowerValidatedSolutions

5. Verify that all PowerShell modules are installed correctly.

   Test-PowerValidatedSolutionsPrereq

6. Proceed with the implementation of the validated solution.

Disconnected Environment

1. Verify that your system has PowerShell 7.2 or later installed. See Microsoft PowerShell.
2. Start PowerShell.
3. Create a folder to store the saved PowerShell Modules.
   1. Replace the variables with your values and run the commands.

      $drive = "F:\"
      $saveModuleFolder = "modules\"

   2. Perform the configuration by running the command in the PowerShell console.

      New-Item -Path $drive$saveModuleFolder -ItemType Directory

4. From a system with an Internet connection, save the module dependencies from the PowerShell Gallery.

   Save-Module -Name VMware.PowerCLI -Path "$drive$saveModuleFolder" -Repository PSGallery
   Save-Module -Name VMware.vSphere.SsoAdmin -Path "$drive$saveModuleFolder" -Repository PSGallery
   Save-Module -Name PowerVCF -Path "$drive$saveModuleFolder" -Repository PSGallery
   Save-Module -Name PowerValidatedSolutions -Path "$drive$saveModuleFolder" -Repository PSGallery
   Save-Module -Name ImportExcel -Path "$drive$saveModuleFolder" -Repository PSGallery

5. From the system with the Internet connection, copy the module dependencies to a target system.

   Copy-Item -Path "$drive$saveModuleFolder*" -Destination '\\<destination_host>\C$\Program Files\WindowsPowerShell\Modules\' -Recurse

6. Import the PowerShell Module for VMware Validated Solutions.

   Import-Module -Name PowerValidatedSolutions

7. Verify that all PowerShell modules are installed correctly.

   Test-PowerValidatedSolutionsPrereq

8. Proceed with the implementation of the validated solution.

PowerShell Implementation

1. Start PowerShell.
2. Create a folder structure to store the validated solution PowerShell content.
   1. Replace the variables with your values and run the commands in the PowerShell console.

      $drive = "F:\"
      $parentFolder = "validatedSolutions\"
      $cerificateFolder = "certificates\"
      $binariesFolder = "binaries\"
      $jsonFolder = "generatedJsons\"

   2. Perform the configuration by running the command in the PowerShell console.

      New-Item -Path $drive$parentFolder, "$drive$parentFolder$cerificateFolder", "$drive$parentFolder$jsonFolder", "$drive$parentFolder$binariesFolder" -ItemType Directory
      Set-Location -Path "$drive$parentFolder"

3. Start the VMware Validated Solution PowerShell menu.
   1. Move your completed VMware Cloud Foundation Planning and Preparation Workbook in the validatedSolutions root folder.
   2. Replace the variables with your values and run the command.

      $pnpWorkbook = "instanceA-pnpWorkbook.xlsx"

   3. Start the VMware Validated Solution PowerShell menu.

      Start-ValidatedSolutionMenu -jsonPath "$drive$parentFolder$jsonFolder" -certificatePath "$drive$parentFolder$cerificateFolder" -binaryPath "$drive$parentFolder$binariesFolder" -protectedWorkbook "$drive$parentFolder$pnpWorkbook" -logPath "$drive$parentFolder"

4. From the main menu, enter 04. (IAM) Identity and Access Management.

5. To generate the Identity and Access Management JSON specification file based on the VMware Cloud Foundation Planning and Preparation Workbook, enter 01. Generate JSON Specification File.

6. To verify that your environment meets all prerequisites, enter 02. Verify Prerequisites.
7. To retrieve the root signed certificate (.pem) for Microsoft Active Directory domain, enter 03. Request Root Certificate for the Microsoft Active Directory Domain.
8. To perform the end-to-end deployment, enter 05. End-to-End Deployment.