Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
Added sectin for Updating the Module.

#56

Signed-off-by: Ryan Johnson <johnsonryan@vmware.com>
  • Loading branch information
tenthirtyam committed Dec 21, 2022
1 parent 0cb4df7 commit 9d7c4a4
Showing 1 changed file with 27 additions and 1 deletion.
28 changes: 27 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,10 @@ Install-Module -Name VMware.CloudFoundation.Reporting

If using VMware Photon OS, import the modules before proceeding:

For example:

```powershell
Import-Module -Name PowerValidatedSolutions
Import-Module -Name VMware.CloudFoundation.Reporting
```

To verify the modules are installed, run the following command in the PowerShell console.
Expand Down Expand Up @@ -91,6 +93,30 @@ Get-Help -Name Invoke-VcfHealthReport
Get-Help -Name Invoke-VcfHealthReport -Examples
```

## Updating the Module

Update the PowerShell module and its dependencies from the PowerShell Gallery by running the following commands:

```powershell
Update-Module -Name VMware.PowerCLI
Update-Module -Name VMware.vSphere.SsoAdmin
Update-Module -Name PowerVCF
Update-Module -Name PowerValidatedSolutions
Update-Module -Name VMware.CloudFoundation.Reporting
```

To verify that the PowerShell module is updated, run the following command in the PowerShell console.

```powershell
Get-InstalledModule -Name VMware.CloudFoundation.Reporting
```

To verify the dependencies are updated and meet the minimum requirements, run the following command in the PowerShell console.

```powershell
Test-VcfReportingPrereq
```

## User Access

Each cmdlet may provide one or more usage examples. Many of the cmdlets require that credentials are provided to output to the PowerShell console or a report.
Expand Down

0 comments on commit 9d7c4a4

Please sign in to comment.