chore(re-release): v1.5.4 (vmware#126)

Re-release v1.5.4. Bugfix: - Fixed issue in import of prior release v1.5.4.1002 in `Install-VCFCertificate`. - Updated `Install-VCFCertificate` to remove duplicate parameters. Documentation: - Updated documentation for `Install-VCFCertificate` for readability. Signed-off-by: Ryan Johnson <[email protected]>
garlicNova · Aug 7, 2024 · 67b23da · 67b23da
1 parent ba20512
commit 67b23da
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 16 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,7 +2,7 @@
 
 ## v1.5.4
 
-> Release Date: 2024-07-25
+> Release Date: 2024-08-07
 
 Enhancement:
 

diff --git a/VMware.CloudFoundation.CertificateManagement.psd1 b/VMware.CloudFoundation.CertificateManagement.psd1
@@ -3,15 +3,15 @@
 
 # Module manifest for module 'VMware.CloudFoundation.CertificateManagement'
 # Generated by: Broadcom
-# Generated on: 2024-07-25
+# Generated on: 2024-08-07
 
 @{
 
     # Script module or binary module file associated with this manifest.
     RootModule        = '.\VMware.CloudFoundation.CertificateManagement.psm1'
 
     # Version number of this module.
-    ModuleVersion     = '1.5.4.1002'
+    ModuleVersion     = '1.5.4.1003'
 
     # ID used to uniquely identify this module
     GUID              = 'ac903c83-c745-44f7-b6bd-1dff133fec92'

diff --git a/VMware.CloudFoundation.CertificateManagement.psm1 b/VMware.CloudFoundation.CertificateManagement.psm1
@@ -1575,7 +1575,7 @@ Function Set-VCFCertificateAuthority {
         [Parameter (Mandatory = $true, ParameterSetName = "openssl")] [ValidateNotNullOrEmpty()] [String] $commonName,
         [Parameter (Mandatory = $true, ParameterSetName = "openssl")] [ValidateNotNullOrEmpty()] [String] $organization,
         [Parameter (Mandatory = $true, ParameterSetName = "openssl")] [ValidateNotNullOrEmpty()] [String] $organizationUnit,
-        
+
         [Parameter (Mandatory = $true, ParameterSetName = "openssl")] [ValidateNotNullOrEmpty()] [String] $locality,
         [Parameter (Mandatory = $true, ParameterSetName = "openssl")] [ValidateNotNullOrEmpty()] [String] $state,
         [Parameter (Mandatory = $true, ParameterSetName = "openssl")] [ValidateSet ("US", "CA", "AX", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", `
@@ -2434,8 +2434,8 @@ Function Install-VCFCertificate {
             }
         }
     } else {
-		Install-SddcCertificate -server $server -user $user -pass $pass -workloadDomain $domain
-	}
+        Install-SddcCertificate -server $server -user $user -pass $pass -workloadDomain $domain
+    }
 }
 
 Function Install-SddcCertificate {

diff --git a/docs/documentation/functions/Install-VCFCertificate.md b/docs/documentation/functions/Install-VCFCertificate.md
@@ -52,20 +52,21 @@ This example will connect to SDDC Manager to install the signed certificates for
 Install-VCFCertificate -esxi -server sfo-vcf01.sfo.rainpole.io -user [email protected] -pass VMw@re1! -domain sfo-m01 -esxiFqdn sfo01-m01-esx01.sfo.rainpole.io -migratePowerOffVMs -vsanDataMigrationMode EnsureAccessibility -certificateDirectory F:\certificates -certificateFileExt ".cer"
 ```
 
-This example will install the certificate to the ESXi host sfo01-m01-esx01.sfo.rainpole.io in sfo-m01 workload domain using the provided path. For VMware Cloud Foundation 
-version earlier than 5.2, the ESXi host will enter maintenance mode with vSAN data migration Mode set to `EnsureAccessibility`.  Any powered-off virtual machines will be
-migrated off the ESXi host prior to entering maintenance mode.
+This example will install the certificate to the ESXi host sfo01-m01-esx01.sfo.rainpole.io in sfo-m01 workload domain using the provided path.
+
+For VMware Cloud Foundation 5.1 or earlier, the ESXi host will enter maintenance mode with vSAN data migration Mode set to `EnsureAccessibility`. Any powered off virtual machines will be migrated off the ESXi host prior to entering maintenance mode.
 
 ### EXAMPLE 3
 
 ```powershell
 Install-VCFCertificate -esxi -server sfo-vcf01.sfo.rainpole.io -user [email protected] -pass VMw@re1! -domain sfo-m01 -cluster sfo-m01-cl01 -certificateDirectory F:\certificates -certificateFileExt ".cer"
 ```
 
-This example will install certificates for each ESXi host in the sfo-m01-cl01 cluster within the sfo-m01 workload domain, using the provided path.  Starting from VMware Cloud
-Foundation version is 5.2 or later, the vsanDataMigrationMode option is no longer applicable. For VMware Cloud Foundation version earlier than 5.2, by default the ESXi hosts will
-enter maintenance mode with vSAN data migration Mode set to `Full data migration`.  Any powered-off virtual machines will not be migrated off the ESXi hosts prior to 
-entering maintenance mode.
+This example will install certificates for each ESXi host in the sfo-m01-cl01 cluster within the sfo-m01 workload domain, using the provided path.
+
+For VMware Cloud Foundation 5.2 or later, the `vsanDataMigrationMode` option is no longer applicable.
+
+For VMware Cloud Foundation 5.1 or earlier, by default the ESXi hosts will enter maintenance mode with vSAN data migration Mode set to `Full data migration`. Any powered off virtual machines will not be migrated off the ESXi hosts prior to entering maintenance mode.
 
 ### EXAMPLE 4
 
@@ -74,7 +75,8 @@ Install-VCFCertificate -esxi -server sfo-vcf01.sfo.rainpole.io -user administrat
 ```
 
 This example will install private keys and certificates for each ESXi host in the sfo-m01-cl01 cluster within the sfo-m01 workload domain, using the provided path.
-The `uploadprivatekey` parameter is only validated for VMware Cloud Foundation version is 5.2 or later.
+
+The `uploadPrivateKey` parameter is only validated for VMware Cloud Foundation version is 5.2 or later.
 
 ## Parameters
 
@@ -255,9 +257,10 @@ Default value: 18000
 Accept pipeline input: False
 Accept wildcard characters: False
 ```
+
 ### -vsanDataMigrationMode
 
-The vSan Data Migration mode validate value ("Full", "EnsureAccessibility").
+The vSAN Data Migration mode validate value ("Full", "EnsureAccessibility").
 
 ```yaml
 Type: String
@@ -305,7 +308,7 @@ Accept wildcard characters: False
 
 ### -uploadPrivateKey
 
-Option to upload an external private key when performing the ESXi host certificate replacement.  Supported on Vmware Cloud Foundation 5.2 or later
+Option to upload an external private key when performing the ESXi host certificate replacement. Supported on VMware Cloud Foundation 5.2 or later
 
 ```yaml
 Type: Switch