Implement the Identity and Access Management for VMware Cloud Foundation validated solution using the PowerShell Module for VMware Validated Solutions.

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:

Please refer to the documentation for more information on how to use this module.

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 by running the following commands:

    Install-Module -Name VMware.PowerCLI -MinimumVersion 13.2.1 -Scope AllUsers
    Install-Module -Name VMware.vSphere.SsoAdmin -MinimumVersion 1.3.9 -Scope AllUsers
    Install-Module -Name ImportExcel -MinimumVersion 7.8.5 -Scope AllUsers
    Install-Module -Name PowerVCF -MinimumVersion 2.4.0 -Scope AllUsers
    Install-Module -Name PowerValidatedSolutions -MinimumVersion 2.10.0 -Scope AllUsers
  4. Import the PowerShell Module for VMware Validated Solutions by running the following command.

    Import-Module -Name PowerValidatedSolutions
  5. Verify that all PowerShell modules have been 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 values in the sample code with your values and run the commands in the PowerShell console.

      $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 by running the following commands in the PowerShell console.

    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 by running the following commands in the PowerShell console:

    Copy-Item -Path "$drive$saveModuleFolder*" -Destination '\\<destination_host>\C$\Program Files\WindowsPowerShell\Modules\' -Recurse
  6. Import the PowerShell Module for VMware Validated Solutions by running the following command.

    Import-Module -Name PowerValidatedSolutions
  7. Proceed with the implementation of the validated solution.

PowerShell Implementation

  1. Start PowerShell

  2. Create a folder structure to store the Validated Solutions content

    1. Replace the values in the sample code 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. Place your completed VMware Cloud Foundation Planning and Preparation Workbook in the root of the validatedSolutions folder created in Step 2.

  4. Start the VMware Validated Solution menu.

    1. Replace the values in the sample code with your values and run the commands in the PowerShell console.

      $pnpWorkbook = "instanceA-pnpWorkbook.xlsx"
    2. Start the menu by running the command in the PowerShell console.

      Start-ValidatedSolutionMenu -jsonPath "$drive$parentFolder$jsonFolder" -certificatePath "$drive$parentFolder$cerificateFolder" -binaryPath "$drive$parentFolder$binariesFolder" -protectedWorkbook "$drive$parentFolder$pnpWorkbook" -logPath "$drive$parentFolder"
  5. Select 03. (IAM) Identity and Access Management from the main menu.

  6. Generate the Identity and Access Management JSON specification file using the VMware Cloud Foundation Planning and Preparation Workbook by selecting 01. Generate JSON Specification File.

  7. Verify that all prerequisites are in place before starting the end-to-end deployment by selecting 02. Verify Prerequisites.

  8. Retrieve the root signed certificate (.pem) for Microsoft Active Directory domain by selecting 03. Request Root Certificate for the Microsoft Active Directory Domain.

  9. Perfrom the end-to-end deployment by selecting 05. End-to-End Deployment.