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

Commit 8921339

Browse files
author
Kevin Teng
authored
docs: update description for Install-VCFCertificates (#125)
Updates the description for `Install-VCFCertificates`. Signed-off-by: Kevin Teng <kevin.teng@broadcom.com>
1 parent 8d1eb7c commit 8921339

2 files changed

Lines changed: 19 additions & 51 deletions

File tree

VMware.CloudFoundation.CertificateManagement.psm1

Lines changed: 10 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2251,29 +2251,22 @@ Function Install-VCFCertificate {
22512251
22522252
.EXAMPLE
22532253
Install-VCFCertificate -esxi -server sfo-vcf01.sfo.rainpole.io -user administrator@vsphere.local -pass VMw@re1! -domain sfo-m01 -esxiFqdn sfo01-m01-esx01.sfo.rainpole.io -migratePowerOffVMs -vsanDataMigrationMode EnsureAccessibility -certificateDirectory F:\certificates -certificateFileExt ".cer"
2254-
This example will install the certificate to the ESXi host sfo01-m01-esx01.sfo.rainpole.io in domain sfo-m01 from the provided path. When VMware Cloud Foundation
2255-
version is earlier than 5.2, the ESXi host will enter maintenance mode with migrate Powered off VMs option enabled and vSAN data migration mode set to EnsureAccessibility.
2256-
2257-
.EXAMPLE
2258-
Install-VCFCertificate -esxi -server sfo-vcf01.sfo.rainpole.io -user administrator@vsphere.local -pass VMw@re1! -domain sfo-m01 -cluster sfo-m01-cl01 -vsanDataMigrationMode EnsureAccessibility -certificateDirectory F:\certificates -certificateFileExt ".cer"
2259-
This example will install certificates for each ESXi host in cluster sfo-m01-cl01 in workload domain sfo-m01 from the provided path. When VMware Cloud Foundation
2260-
version is earlier than 5.2, the ESXi host will enter maintenance mode with migrate Powered off VMs option disabled and vSAN data migration mode set to EnsureAccessibility.
2254+
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
2255+
version earlier than 5.2, the ESXi hosts will enter maintenance mode with vSAN data migration Mode set to `EnsureAccessibility`. Any powered-off virtual machines will be
2256+
migrated off the ESXi hosts prior to entering maintenance mode.
22612257
22622258
.EXAMPLE
22632259
Install-VCFCertificate -esxi -server sfo-vcf01.sfo.rainpole.io -user administrator@vsphere.local -pass VMw@re1! -domain sfo-m01 -cluster sfo-m01-cl01 -certificateDirectory F:\certificates -certificateFileExt ".cer"
2264-
This example will install certificates for each ESXi host in cluster sfo-m01-cl01 in workload domain sfo-m01 from the provided path. When VMware Cloud Foundation
2265-
version is 5.2 or later, the vsanDataMigrationMode option no longer applied.
2260+
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
2261+
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
2262+
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
2263+
entering maintenance mode.
22662264
22672265
.EXAMPLE
22682266
Install-VCFCertificate -esxi -server sfo-vcf01.sfo.rainpole.io -user administrator@vsphere.local -pass VMw@re1! -domain sfo-m01 -cluster sfo-m01-cl01 -certificateDirectory F:\certificates -certificateFileExt ".cer" -uploadPrivateKey
2269-
This example will install private keys and certificates for each ESXi host in cluster sfo-m01-cl01 in workload domain sfo-m01 from the provided path. The uploadprivatekey
2270-
parameter is only validate for VMware Cloud Foundation version is 5.2 or later.
2271-
2272-
.EXAMPLE
2273-
Install-VCFCertificate -esxi -server sfo-vcf01.sfo.rainpole.io -user administrator@vsphere.local -pass VMw@re1! -domain sfo-m01 -esxiFqdn sfo01-m01-esx01.sfo.rainpole.io -migratePowerOffVMs -vsanDataMigrationMode EnsureAccessibility -certificateDirectory F:\certificates -certificateFileExt ".cer"
2274-
This example will install the certificate to the ESXi host sfo01-m01-esx01.sfo.rainpole.io in domain sfo-m01 from the provided path. When VMware Cloud Foundation
2275-
version is earlier than 5.2, the ESXi host will enter maintenance mode with migrate Powered off VMs option enabled and vSAN data migration mode set to EnsureAccessibility.
2276-
2267+
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.
2268+
The `uploadprivatekey` parameter is only validated for VMware Cloud Foundation version is 5.2 or later.
2269+
22772270
.PARAMETER server
22782271
The fully qualified domain name of the SDDC Manager instance.
22792272

docs/documentation/functions/Install-VCFCertificate.md

Lines changed: 9 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -52,54 +52,29 @@ This example will connect to SDDC Manager to install the signed certificates for
5252
Install-VCFCertificate -esxi -server sfo-vcf01.sfo.rainpole.io -user administrator@vsphere.local -pass VMw@re1! -domain sfo-m01 -esxiFqdn sfo01-m01-esx01.sfo.rainpole.io -migratePowerOffVMs -vsanDataMigrationMode EnsureAccessibility -certificateDirectory F:\certificates -certificateFileExt ".cer"
5353
```
5454

55-
This example will install the certificate to the ESXi host sfo01-m01-esx01.sfo.rainpole.io in domain sfo-m01 from the provided path. When VMware Cloud Foundation
56-
version is earlier than 5.2, the ESXi host will enter maintenance mode with Migrate Power off VMs option enabled and vSAN data migration Mode set to `EnsureAccessibility`.
55+
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
56+
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
57+
migrated off the ESXi host prior to entering maintenance mode.
5758

5859
### EXAMPLE 3
5960

6061
```powershell
6162
Install-VCFCertificate -esxi -server sfo-vcf01.sfo.rainpole.io -user administrator@vsphere.local -pass VMw@re1! -domain sfo-m01 -cluster sfo-m01-cl01 -certificateDirectory F:\certificates -certificateFileExt ".cer"
6263
```
6364

64-
This example will install certificates for each ESXi host in cluster sfo-m01-cl01 in workload domain sfo-m01 from the provided path. When VMware Cloud Foundation
65-
version is 5.2 or later, the vsanDataMigrationMode option no longer applied.
65+
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
66+
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
67+
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
68+
entering maintenance mode.
6669

6770
### EXAMPLE 4
6871

6972
```powershell
7073
Install-VCFCertificate -esxi -server sfo-vcf01.sfo.rainpole.io -user administrator@vsphere.local -pass VMw@re1! -domain sfo-m01 -cluster sfo-m01-cl01 -certificateDirectory F:\certificates -certificateFileExt ".cer" -uploadPrivateKey
7174
```
7275

73-
This example will install private keys and certificates for each ESXi host in cluster sfo-m01-cl01 in workload domain sfo-m01 from the provided path. The uploadprivatekey
74-
parameter is only validate for VMware Cloud Foundation version is 5.2 or later.
75-
76-
### EXAMPLE 5
77-
78-
```powershell
79-
Install-VCFCertificate -esxi -server sfo-vcf01.sfo.rainpole.io -user administrator@vsphere.local -pass VMw@re1! -domain sfo-m01 -cluster sfo-m01-cl01 -certificateDirectory F:\certificates -certificateFileExt ".cer"
80-
```
81-
82-
This example will install certificates for each ESXi host in cluster sfo-m01-cl01 in workload domain sfo-m01 from the provided path. When VMware Cloud Foundation
83-
version is 5.2 or later, the vsanDataMigrationMode option no longer applied.
84-
85-
### Example 4
86-
87-
```powershell
88-
Install-VCFCertificate -esxi -server sfo-vcf01.sfo.rainpole.io -user administrator@vsphere.local -pass VMw@re1! -domain sfo-m01 -cluster sfo-m01-cl01 -certificateDirectory F:\certificates -certificateFileExt ".cer" -uploadPrivateKey
89-
```
90-
91-
This example will install private keys and certificates for each ESXi host in cluster sfo-m01-cl01 in workload domain sfo-m01 from the provided path. The uploadprivatekey
92-
parameter is only available for VMware Cloud Foundation version is 5.2 or later.
93-
94-
### Example 5
95-
96-
```powershell
97-
Install-VCFCertificate -esxi -server sfo-vcf01.sfo.rainpole.io -user administrator@vsphere.local -pass VMw@re1! -domain sfo-m01 -esxiFqdn sfo01-m01-esx01.sfo.rainpole.io -migratePowerOffVMs -vsanDataMigrationMode EnsureAccessibility -certificateDirectory F:\certificates -certificateFileExt ".cer"
98-
```
99-
100-
This example will install the certificate to the ESXi host sfo01-m01-esx01.sfo.rainpole.io in domain sfo-m01 from the provided path. When VMware Cloud Foundation
101-
version is earlier than 5.2, the ESXi host will enter maintenance mode with Migrate Power off VMs option enabled and vSAN data migration Mode set to EnsureAccessibility.
102-
76+
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.
77+
The `uploadprivatekey` parameter is only validated for VMware Cloud Foundation version is 5.2 or later.
10378

10479
## Parameters
10580

0 commit comments

Comments
 (0)