Skip to content
This repository was archived by the owner on Nov 25, 2025. It is now read-only.

Commit c577d01

Browse files
committed
docs: sanitize examples
- Sanitizes the examples. - Updates the case of function names and related documentation files. Signed-off-by: Ryan Johnson <ryan.johnson@broadcom.com>
1 parent d869f91 commit c577d01

27 files changed

Lines changed: 578 additions & 584 deletions

CHANGELOG.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@
77
Enhancement:
88

99
- Added Pester tests for certificate management. [GH-119](https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-certificate-management/pull/119)
10-
- Add support for non-disruptive ESXi certificate replacement in VMware Cloud Foundation 5.2 to `Install-VCFCertificate` function. [GH-123](https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-certificate-management/pull/123)
11-
- Add support for uploading the private key for non-disruptive ESXi certificate replacement in VMware Cloud Foundation 5.2 to `Install-VCFCertificate` function. [GH-123](https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-certificate-management/pull/123)
10+
- Add support for non-disruptive ESX certificate replacement in VMware Cloud Foundation 5.2 to `Install-VcfCertificate` function. [GH-123](https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-certificate-management/pull/123)
11+
- Add support for uploading the private key for non-disruptive ESX certificate replacement in VMware Cloud Foundation 5.2 to `Install-VcfCertificate` function. [GH-123](https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-certificate-management/pull/123)
1212

1313
Chore:
1414

@@ -36,7 +36,7 @@ Chore:
3636
3737
Enhancement:
3838

39-
- Added a restart for specific vCenter Server services to `Set-EsxiCertificateMode` function. [GH-110](https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-certificate-management/pull/110)
39+
- Added a restart for specific vCenter services to `Set-EsxiCertificateMode` function. [GH-110](https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-certificate-management/pull/110)
4040

4141
## v1.5.1
4242

@@ -82,10 +82,10 @@ Bugfix:
8282
8383
Enhancement:
8484

85-
- **Breaking Change**: Renamed `Set-SddcCertificateAuthority` to `Set-VCFCertificateAuthority`. [GH-74](https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-certificate-management/pull/74)
86-
- **Breaking Change**: Renamed `Request-SddcCertificate` to `Request-VCFSignedCertificate`. [GH-74](https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-certificate-management/pull/74)
85+
- **Breaking Change**: Renamed `Set-SddcCertificateAuthority` to `Set-VcfCertificateAuthority`. [GH-74](https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-certificate-management/pull/74)
86+
- **Breaking Change**: Renamed `Request-SddcCertificate` to `Request-VcfSignedCertificate`. [GH-74](https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-certificate-management/pull/74)
8787
- **Breaking Change**: Refactored `Set-SddcCertificateAuthority` to support OpenSSL Certificate Authority configuration. [GH-68](https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-certificate-management/pull/68)
88-
- **Breaking Change**: Refactored `Get-EsxiCertificateThumbprint` and `Get-vCenterCertificateThumbprint` to a single function `Get-VCFCertificateThumbprint`. [GH-68](https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-certificate-management/pull/68)
88+
- **Breaking Change**: Refactored `Get-EsxiCertificateThumbprint` and `Get-vCenterCertificateThumbprint` to a single function `Get-VcfCertificateThumbprint`. [GH-68](https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-certificate-management/pull/68)
8989
- Added `Request-VcfCsr`as a wrapper for `Request-EsxiCsr` and `Request-SddcCsr`. [GH-68](https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-certificate-management/pull/68)
9090
- Added `Install-VcfCertificate` as a wrapper for `Install-EsxiCertificate` and `Install-SddcCertificate`. [GH-68](https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-certificate-management/pull/68)
9191

@@ -139,14 +139,14 @@ Chore:
139139
140140
Enhancement:
141141

142-
- Added support for an ESXi certificate management pre-check with `Test-EsxiCertMgmtChecks` cmdlet. [GH-37](https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-certificate-management/pull/37)
142+
- Added support for an ESX certificate management pre-check with `Test-EsxiCertMgmtChecks` cmdlet. [GH-37](https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-certificate-management/pull/37)
143143
- Added support for PowerShell Core. [GH-37](https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-certificate-management/pull/37)
144144
- Added support for VMware PhotonOS. [GH-37](https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-certificate-management/pull/37)
145145
- Enhanced `Get-vSANHealthSummary` cmdlet improving log messages and adding a check for vSAN services. [GH-37](https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-certificate-management/pull/37)
146146

147147
Bugfix:
148148

149-
- Added a disconnect from vCenter Server prior to an ESXi host reboot. [GH-36](https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-certificate-management/pull/36)
149+
- Added a disconnect from vCenter prior to an ESX host reboot. [GH-36](https://github.com/vmware/powershell-module-for-vmware-cloud-foundation-certificate-management/pull/36)
150150

151151
## v1.0.0
152152

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
## Overview
1414

15-
`VMware.CloudFoundation.CertificateManagement` is a PowerShell module design to provide you the ability to manage
15+
`VMware.CloudFoundation.CertificateManagement` is a PowerShell module designed to provide you the ability to manage
1616
certificates within your VMware Cloud Foundation environment.
1717

1818
Using this module, you can perform various tasks on a VMware Cloud Foundation instance or a specific

VMware.CloudFoundation.CertificateManagement.psd1

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@
44

55
# Module manifest for module 'VMware.CloudFoundation.CertificateManagement'
66
# Generated by: Broadcom
7-
# Generated on: 2024-08-07
7+
# Generated on: 2025-05-05
88

99
@{
1010

1111
# Script module or binary module file associated with this manifest.
1212
RootModule = '.\VMware.CloudFoundation.CertificateManagement.psm1'
1313

1414
# Version number of this module.
15-
ModuleVersion = '1.5.5.1000'
15+
ModuleVersion = '1.5.5.1001'
1616

1717
# ID used to uniquely identify this module
1818
GUID = 'ac903c83-c745-44f7-b6bd-1dff133fec92'
@@ -75,7 +75,7 @@
7575
# NestedModules = @()
7676

7777
# Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export.
78-
FunctionsToExport = 'Install-VCFCertificate', 'Get-VCFCertificateThumbprint', 'Confirm-EsxiCertificateInstalled', 'Confirm-CAInvCenterServer', 'Request-VCFCsr', 'Get-EsxiCertificateMode', 'Set-EsxiCertificateMode', 'Get-vSANHealthSummary', 'Get-EsxiLockdownMode', 'Set-EsxiLockdownMode', 'Restart-EsxiHost', 'Test-EsxiCertMgmtChecks', 'Set-VCFCertificateAuthority', 'Request-VCFSignedCertificate', 'Get-EsxiHostVsanMaintenanceModePrecheck'
78+
FunctionsToExport = 'Install-VcfCertificate', 'Get-VcfCertificateThumbprint', 'Confirm-EsxiCertificateInstalled', 'Confirm-CAInvCenterServer', 'Request-VcfCsr', 'Get-EsxiCertificateMode', 'Set-EsxiCertificateMode', 'Get-vSANHealthSummary', 'Get-EsxiLockdownMode', 'Set-EsxiLockdownMode', 'Restart-EsxiHost', 'Test-EsxiCertMgmtChecks', 'Set-VcfCertificateAuthority', 'Request-VcfSignedCertificate', 'Get-EsxiHostVsanMaintenanceModePrecheck'
7979

8080
# Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.
8181
CmdletsToExport = @()

0 commit comments

Comments
 (0)