Skip to content

Commit 31e751b

Browse files
committed
Updated VCF module help
Added help examples
1 parent 03152d7 commit 31e751b

File tree

1 file changed

+15
-11
lines changed

1 file changed

+15
-11
lines changed

PureStorage.FlashArray.VMware.VCF/PureStorage.FlashArray.VMware.VCF.psm1

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ function Initialize-PfaVcfWorkloadDomain {
33
.SYNOPSIS
44
Configures a workload domain for Pure Storage
55
.DESCRIPTION
6-
Connects to each ESXi host, configures initiators on the FlashArray and provisions a VMFS. If something fails it will cleanup any changes.
6+
Configures FlashArray host group, provisions vVol Protocol Endpoint or VMFS datastore, configures iSCSI (if needed), preps ESXi hosts, validates and commissions hosts in VCF SDDC Manager.
77
.INPUTS
8-
FQDNs or IPs of each host, valid credentials, a FlashArray connection, a datastore name and size.
8+
FQDNs or IPs of each host, valid credentials, a FlashArray FQDN and credentials, protocol choice, a datastore name and size OR protocol endpoint.
99
.OUTPUTS
1010
Returns host group.
1111
.NOTES
@@ -15,21 +15,25 @@ function Initialize-PfaVcfWorkloadDomain {
1515
Purpose/Change: Core support
1616
.EXAMPLE
1717
PS C:\ $faCreds = get-credential
18-
PS C:\ New-PfaConnection -endpoint flasharray-m20-2 -credentials $faCreds -ignoreCertificateError -defaultArray
19-
PS C:\ $creds = get-credential
20-
PS C:\ Initialize-PfaVcfWorkloadDomain -esxiHosts "esxi-02.purecloud.com","esxi-04.purecloud.com" -credentials $creds -datastoreName "vcftest" -sizeInTB 16 -fc
18+
PS C:\ $esxiCreds = get-credential
19+
PS C:\ Initialize-PfaVcfWorkloadDomainTest -EsxiHostFqdn "esxi-02.purecloud.com","esxi-04.purecloud.com" -esxihostcredential $esxiCreds -Protocol iSCSI -Vvol -FlashArrayFqdn flasharray-m20-1 -FlashArrayCredential $facreds -vcfnetworkpool iSCSI-vVols
2120
22-
Creates a host group and hosts and provisions a 16 TB VMFS to the hosts over FC
21+
Configures and commissions hosts for inclusion in a iSCSI vVol Principal Workload Domain.
22+
.EXAMPLE
23+
PS C:\ $faCreds = get-credential
24+
PS C:\ $esxiCreds = get-credential
25+
PS C:\ Initialize-PfaVcfWorkloadDomainTest -EsxiHostFqdn "esxi-02.purecloud.com","esxi-04.purecloud.com" -esxihostcredential $esxiCreds -FlashArrayFqdn flasharray-m20-1 -FlashArrayCredential $facreds -vcfnetworkpool iSCSI-vVols -datastoreName "vcftest" -sizeInTB 16 -Protocol fc
26+
27+
Configures and commissions hosts for inclusion in a FC VMFS Principal Workload Domain.
2328
.EXAMPLE
2429
PS C:\ $faCreds = get-credential
25-
PS C:\ New-PfaConnection -endpoint flasharray-m20-2 -credentials $faCreds -ignoreCertificateError -defaultArray
26-
PS C:\ $creds = get-credential
30+
PS C:\ $esxiCreds = get-credential
2731
PS C:\ $allHosts = @()
2832
PS C:\ Import-Csv C:\hostList.csv | ForEach-Object {$allHosts += $_.hostnames}
29-
PS C:\ Initialize-PfaVcfWorkloadDomain -esxiHosts $allHosts -credentials $creds -datastoreName "vcftest" -sizeInTB 16 -fc
33+
PS C:\ Initialize-PfaVcfWorkloadDomainTest -EsxiHostFqdn $allHosts-esxihostcredential $esxiCreds -Protocol iSCSI -Vvol -FlashArrayFqdn flasharray-m20-1 -FlashArrayCredential $facreds -vcfnetworkpool iSCSI-vVols
3034
31-
Creates a host group and hosts and provisions a 16 TB VMFS to the hosts over FC. This takes in a csv file of ESXi host FQDNs with one csv header called hostnames
32-
35+
Configures and commissions hosts for inclusion in a iSCSI vVol Principal Workload Domain using a CSV source file with a column heading of hostnames.
36+
3337
*******Disclaimer:******************************************************
3438
This scripts are offered "as is" with no warranty. While this
3539
scripts is tested and working in my environment, it is recommended that you test

0 commit comments

Comments
 (0)