Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update README.md #57

Merged
merged 1 commit into from
Dec 21, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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