Installing the Module¶
From Powershell Gallery¶
Verify that your system has a supported edition and version of PowerShell installed.
Install the PowerShell module dependencies from the PowerShell Gallery by running the following commands:
Set-PSRepository -Name PSGallery -InstallationPolicy Trusted
Install-Module -Name VMware.PowerCLI -MinimumVersion 13.1.0 -Repository PSGallery
Install-Module -Name VMware.vSphere.SsoAdmin -MinimumVersion 1.3.9 -Repository PSGallery
Install-Module -Name PowerVCF -MinimumVersion 2.3.0 -Repository PSGallery
Install-Module -Name PowerValidatedSolutions -MinimumVersion 2.6.0 -Repository PSGallery
Install-Module -Name VMware.CloudFoundation.Reporting -Repository PSGallery
If using PowerShell 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
From Air-gapped Machine¶
Verify that your system has a supported edition and version of PowerShell installed.
Save Modules module dependencies from the PowerShell Gallery on a non air-gapped machine by running the following commands:
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
Copy the PowerShell Modules module dependencies from the Local Machine to air-gapped facing machine by running the following commands:
Copy-Item -Path F:\Module\* -Destination '\\<destination_host>\C$\Program Files\WindowsPowerShell\Modules\' -Recurse
Import the PowerShell Modules module dependencies from the air-gapped machine by running the following commands:
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 install on Linux Machine
mkdir /home/modules
Save Modules module dependencies from the PowerShell Gallery on a non air-gapped machine by running the following commands:
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
Copy the PowerShell Modules module dependencies from the Local Machine to air-gapped facing machine by running the following commands:
scp -r /home/modules/* username@remote_host:/home/lab/.local/share/powershell/Modules/
Import the PowerShell Modules module dependencies from the air-gapped machine by running the following commands in PowerShell:
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
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