Scripts and examples to automate Google Cloud VMware Engine (GCVE) administration with PowerCLI.
These are example scripts that demonstrate how to get started with various GCVE automation tasks. This is provided for convenience and not supported by VMware or Google Cloud. You must review, and potentially adjust the contents, before attempting to use in your own environment.
These modules include commands for seting up authenticated connections and creating key network components. Note that GCVE is based on NSX-T, but there is a shift underway to simply call it NSX.
| Command | Purpose |
|---|---|
| Connect-NsxServerGcve | Run Connect-NsxServer with credentials pulled from Google Cloud |
| Connect-VIServerGcve | Run Connect-VIServer with credentials pulled from Google Cloud |
| Get-GcveFqdn | Get FQDN for VMware vCenter and VMware NSX management interfaces |
| New-DhcpServer | Create new VMware NSX DHCP server object |
| Set-DhcpServerOnTier1 | Attach a DHCP server to a Tier-1 router |
| New-Segment | Create new VMware NSX segment for VMs |
For a full list of commands:
Get-Command -Module GcveAuthentication
Get-Command -Module GcveNetworkAutomationThe GcveDnsSync.psm1 module has a single command that can add, update, or remove Google Cloud DNS records from forward/reverse zones. Read the module help for more info on parameters or check out this quick demo.
Import-Module ./GcveDnsSync.psm1
Get-VM web* | Sync-DnsRecordsFromVm -DomainName multicloud.internal `
-ReverseDomainName 88.10.in-addr.arpaThe GcveContentSync.psm1 module has the Sync-ContentFromBucket command that copies ISO/OVA images from a Google Cloud Storage bucket to a content library. This works with GCVE private clouds or other VMware vSphere environments. Read the module help for parameter details or see it in action.
Import-Module ./GcveContentSync.psm1
Sync-ContentFromBucket -BucketName mybucketThe authentication module leverages the gcloud CLI to authenticate with Google Cloud. This provides for seamless access to your GCVE private cloud management credentials for VMware vCenter and VMware NSX. Ensure gcloud is properly initialized with your credentials as well as project ID and GCP zone where your private cloud is deployed. For example:
gcloud config set core/project <project ID>
gcloud config set compute/zone <GCVE zone>If you prefer not to use the authentication provided by the GcveAuthentication.psm1 module, simply use the standard PowerCLI Connect-NsxServer cmdlet.
The PowerShell scripts require VMware PowerCLI, which is a module that can be downloaded automatically, the following commands will get you started:
Set-PSRepository -Name "PSGallery" -InstallationPolicy Trusted
Install-Module -Name VMware.PowerCLIOn Windows, PowerShell execution policy may block these samples. To quickly change the policy, run:
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope LocalMachine -ForceThese samples were developed using PowerShell 7.3.1 and PowerCLI 12.7, 13.0
To learn more, see the PowerCLI documentation.
# Import the modules, connect to vCenter using GCVE credentials:
Import-Module ./GcveNetworkAutomation.psm1,./GcveAuthentication.psm1 -Force
Connect-VIServerGcve -PrivateCloud orange
# Then, use PowerCLI cmdlets as usual with vCenter on GCVE:
Get-VM
Get-Datacenter
# Set up an NSX network segment for VMs after initial
# GCVE private cloud deployment (with or without DHCP)
Connect-NsxServerGcve -PrivateCloud orange
New-DhcpServer -Name dhcp0
Set-DhcpServerOnTier1 -Name dhcp0
New-Segment -Name workload8810 -GatewayAddress 10.88.10.1/24 `
-DhcpRange 10.88.10.100-10.88.10.200 `
-DnsServers 10.88.0.2,10.88.1.2 `
-DomainName multicloud.internal
New-Segment -Name workload8811 -GatewayAddress 10.88.11.1/24View the help for any command using standard PowerShell techniques:
Get-GcveFqdn -?
Get-Help New-Segment -Full