Skip to content

Installing the Module

Verify that your system has a supported edition and version of PowerShell installed.

For environments connected to the Internet, you can install the module dependencies from the PowerShell Gallery by running the following commands in the PowerShell console:

Set-PSRepository -Name PSGallery -InstallationPolicy Trusted
Install-Module -Name VMware.PowerCLI -MinimumVersion 13.2.1 -Repository PSGallery -Scope AllUsers
Install-Module -Name VMware.vSphere.SsoAdmin -MinimumVersion 1.3.9 -Repository PSGallery -Scope AllUsers
Install-Module -Name PowerVCF -MinimumVersion 2.4.1 -Repository PSGallery -Scope AllUsers
Install-Module -Name PowerValidatedSolutions -MinimumVersion 2.10.0 -Repository PSGallery -Scope AllUsers
Install-Module -Name VMware.CloudFoundation.Reporting -Repository PSGallery -Scope AllUsers

If using PowerShell 7 (Core), import the modules before proceeding:

For example:

Import-Module -Name VMware.PowerCLI
Import-Module -Name VMware.vSphere.SsoAdmin
Import-Module -Name PowerVCF
Import-Module -Name PowerValidatedSolutions
Import-Module -Name VMware.CloudFoundation.Reporting

To verify the module dependencies are installed, run the following commands in the PowerShell console.

Example:

$sddcManagerFqdn = "sfo-vcf01.sfo.rainpole.io"
$sddcManagerUser = "admin@local"
$sddcManagerPass = "VMw@re1!VMw@re1!"
Test-VcfReportingPrereq -sddcManagerFqdn $sddcManagerFqdn -sddcManagerUser $sddcManagerUser -sddcManagerPass $sddcManagerPass

For environments disconnected from the Internet (e.g., dark-site, air-gapped), you can save the module dependencies from the PowerShell Gallery by running the following commands in the PowerShell console:

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 F:\Module\ -Repository PSGallery
Save-Module -Name VMware.vSphere.SsoAdmin -Path F:\Module\ -Repository PSGallery
Save-Module -Name PowerVCF -Path F:\Module\ -Repository PSGallery
Save-Module -Name PowerValidatedSolutions -Path F:\Module\ -Repository PSGallery
Save-Module -Name VMware.CloudFoundation.Reporting -Path F:\Module\ -Repository PSGallery

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 F:\Module\* -Destination '\\<destination_host>\C$\Program Files\WindowsPowerShell\Modules\' -Recurse

On the target system, import the module dependencies by running the following commands in the PowerShell console:

Import-Module -Name VMware.PowerCLI
Import-Module -Name VMware.vSphere.SsoAdmin
Import-Module -Name PowerVCF
Import-Module -Name PowerValidatedSolutions
Import-Module -Name VMware.CloudFoundation.Reporting

Prerequisite for module installation on Linux.

mkdir /home/modules

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 /home/modules -Repository PSGallery
Save-Module -Name VMware.vSphere.SsoAdmin -Path /home/modules -Repository PSGallery
Save-Module -Name PowerVCF -Path /home/modules -Repository PSGallery
Save-Module -Name PowerValidatedSolutions -Path /home/modules -Repository PSGallery
Save-Module -Name VMware.CloudFoundation.Reporting -Path /home/modules -Repository PSGallery

From the system with an Internet connection, copy the module dependencies to a target system by running the following commands in the PowerShell console:

scp -r /home/modules/* username@remote_host:/home/lab/.local/share/powershell/Modules/

On the target system, import the module dependencies by running the following commands in the PowerShell console:

Import-Module -Name VMware.PowerCLI
Import-Module -Name VMware.vSphere.SsoAdmin
Import-Module -Name PowerVCF
Import-Module -Name PowerValidatedSolutions
Import-Module -Name VMware.CloudFoundation.Reporting

  Reference

Once installed, any cmdlets associated with VMware.CloudFoundation.Reporting and the its dependencies will be available for use.

To view the cmdlets for available in the module, run the following command in the PowerShell console.

Get-Command -Module VMware.CloudFoundation.Reporting

To view the help for any cmdlet, run the Get-Help command in the PowerShell console.

For example:

Get-Help -Name Invoke-VcfHealthReport
Get-Help -Name Invoke-VcfHealthReport -Examples