PowerVCF

PowerVCF is an open source PowerShell Module for interacting with the VMware Cloud Foundation (SDDC Manager & Cloud Builder) public API.

VMware Cloud Foundation Product Documentation

VMware Cloud Foundation API Documentation

Disclaimer

This is not an officially supported VMware PowerShell Module.

The purpose of this module is to make VMware Cloud Foundation API more accessible to fans of PowerCLI and drive adoption of the VMware Cloud Foundation API & VMware Cloud Foundation in general. It is provided without warranty and should not be used in a production environment without thoroughly testing first.

This version is supported with VMware Cloud Foundation 4.0 and above due to changes in the API auth process.

Contributors

If you would like to contribute please get in touch! Current contributors listed below.

Brian O'Connell - VMware CPBU Staff Architect [Twitter] [Blog]

Gary Blake - VMware CPBU Staff II Architect [Twitter] [Blog]

Ken Gould - VMware CPBU Staff II Architect [Twitter] [Blog]

Giuliano Bertello - Dell EMC Sr. Principal Engineer Solutions Architecture [Twitter] [Blog]

What's New

• NEW New-VCFGroup cmdlet to add a group with a role to SDDC Manager
• NEW Get-VCFUpgrade fetches the list of upgradable components in the System
• NEW Get-VCFConfigurationDNS gets current DNS Config
• NEW Get-VCFConfigurationNTP gets current NTP Config
• NEW Start-VCFUpgrade Trigger an upgrade
• UPDATED Get-VCFUser updated with input value of -type (USER, GROUP, SERVICE)
• UPDATED Get-VCFUser updated with input value of -domain to retrieve all accounts by domain
• UPDATED Get-VCFUpgradable updated Output format
• UPDATED Restart-CloudBuilderSDDC updated with support for a retry with updated JSON spec
• UPDATED Commission-VCFHost to New-VCFCommissionedHost. Commission-VCFHost will still work for backwards compatability for a period of time.
• UPDATED Decommission-VCFHost to Remove-VCFCommissionedHost. Decommission-VCFHost will still work for backwards compatability for a period of time.
• UPDATED Connect-VCFManager to Request-VCFToken. Connect-VCFManager will still work for backwards compatability for a period of time.
• UPDATED Tweaked all cmdlets to use correct standard output and error streams.

Documentation

PowerVCF Documentation

Supported Platforms

This version has been tested using vSAN Ready Nodes. VMware Cloud Foundation on VxRail has not been fully tested, The following cmdlets will not work with VxRail as the workflow is different due to the use of VxRail Manager. Other cmdlets may work subject to testing.

New-VCFCommissionedHost

Remove-VCFCommissionedHost

All Network pool actions

New/Set/Remove Workload domains

Installing the module

Tested in Windows PowerShell 5.x & PowerShell Core 6.x

To install the module from the PowerShell Gallery Open PowerShell as Administrator and run the following

Install-Module -Name PowerVCF

Alternatively to manually install the module download the full module zip from the GitHub repo, extract and run the following in PowerShell

Import-Module .\PowerVCF

Getting Started

All API operations must currently be authenticated using the SDDC Manager admin account. To create a base64 credential to authenticate each cmdlet you must first run:

Connect-VCFManager -fqdn sfo-vcf01.sfo.rainpole.io -username admin -password VMware1!

Note: -username & -password are optional. If not passed a credential window will be presented.

Authentication is only valid for the duration of the PowerShell session.

Examples

Get a list of VCF Hosts

Get-VCFHost

Sample Output

id                  : 598519e7-cbba-4a10-801d-d76111f3ce0e
esxiVersion         : 7.0.0-15843807
fqdn                : sfo01-m01-esx01.sfo.rainpole.io
hardwareVendor      : Dell Inc.
hardwareModel       : PowerEdge R630
ipAddresses         : {@{ipAddress=172.28.211.101; type=MANAGEMENT}, @{ipAddress=172.28.213.101; type=VSAN},            
                      @{ipAddress=172.28.212.101; type=VMOTION}}
cpu                 : @{frequencyMHz=55999.953125; usedFrequencyMHz=11209.0; cores=28; cpuCores=System.Object[]}
memory              : @{totalCapacityMB=262050.28125; usedCapacityMB=59413.0}
storage             : @{totalCapacityMB=7325664.0; usedCapacityMB=297924.625; disks=System.Object[]}
physicalNics        : {@{deviceName=vmnic0; macAddress=24:6e:96:56:10:50}, @{deviceName=vmnic1; macAddress=24:6e:96:56:10:52}, 
                      @{deviceName=vmnic2; macAddress=24:6e:96:56:10:54}, @{deviceName=vmnic3; macAddress=24:6e:96:56:10:55}}
domain              : @{id=51cc2d90-13b9-4b62-b443-c1d7c3be0c23}
networkpool         : @{id=0e06eff5-9fe7-4299-940b-5c8beb3f3ac0; name=sfo-m01-np01}
cluster             : @{id=cc747835-79bc-4900-8703-f5ef1fa87990}
status              : ASSIGNED
bundleRepoDatastore : lcm-bundle-repo
hybrid              : False

Responses can be filtered like this:

Get-VCFHost -id 598519e7-cbba-4a10-801d-d76111f3ce0e | Select esxiVersion

esxiVersion
-----------
7.0.0-15843807

Or like this:

$hostDetail = Get-VCFHost -id 598519e7-cbba-4a10-801d-d76111f3ce0e
$hostDetail.esxiVersion

7.0.0-15843807

Get Help

For a full list of supported cmdlets run the following

Get-Command -Module PowerVCF

All cmdlets support the following

Get-Help cmdlet-name

Get-Help cmdlet-name -examples

Get-Help cmdlet-name -detailed

Get-Help cmdlet-name -full