Skip to content

vBlog.nl

All about technology

Menu
  • Home
  • VMware Cloud Director
  • vSphere
  • Automation
    • PowerCLI
    • PowerShell
    • Terraform
  • NSX
  • Horizon DaaS
  • About Us
Menu

Use Windows 11 Credential Manager for PowerCLI credentials

Posted on August 31, 2022

This article demonstrates how to leverage the built-in Credential Manager in Windows 11 for storing your credentials in PowerShell / PowerCLI scripts.

The story behind this article is that I wanted to build some scripts for VM provisioning and such in my homelab without storing my passwords in plain-text in the script.

By leveraging the -credential parameter and the Windows Credential Manager on my Windows 11 system I’m avoiding the use of usernames and passwords in the script.

Table of Contents

  • Windows 11 Credential Manager
  • Install the Credential Manager module in PowerShell
  • Add new credentials to the Credential Manager
  • Use the credentials in our script
  • Remove the credentials from the Windows Credential Manager
  • External resources

Windows 11 Credential Manager

Credential Manager isn’t a new feature, but it’s still very useful on Windows 11 systems.
The Credential Manager on Windows 11 has the following key features:

  • Store a user’s sign-in information for sites and applications.
  • Store sign-in data for networks such as shared drives or mapped network drives.
  • View, add, remove, and create back-ups of all your stored credentials.

In this article I will connect to a VMware vCenter Server 7.0 using the -credential parameter in PowerCLI.

First I will show my current Credential Manager in Windows 11.

Press Win+S and type Credential Manager.

Open the Windows Credential Manager
Open Windows 11 Credential Manager

Switch from the Web Credentials view to the Windows Credentials view.
These are my existing credentials today. Later on in this article we will see a new credential being added here.

Windows 11 Credential Manager
Windows 11 Credential Manager

The benefits of using Windows Credential Manager to store your PowerShell credentials are:

  • Super easy to connect to VMware ESXi hosts and/or vCenter Servers using the -credential parameter
  • No more saving your username and password inside the script.
  • Credentials Stored in the Credential Manager are associated with your Windows user account, which are
    not transferable between other users on the system.
  • Credentials Stored in the Credential Manager are associated with your Windows user account, which are
    not transferable between systems.

Install the Credential Manager module in PowerShell

To save new credentials in the Windows Credential Manager we will use the New-StoredCredential, which is not available by default: A PowerShell Module must be installed first.

The term 'New-StoredCredential' cmdlet is not recognized as a name of a cmdlet, function, script file, or executable program.
The term ‘New-StoredCredential’ cmdlet is not recognized as a name of a cmdlet, function, script file, or executable program.

Run the following command to install the Windows Credential Manager module

Install-Module -Name CredentialManager -force

After installing, the following three new commands will be available:

Get-StoredCredential
New-StoredCredential
Remove-StoredCredential

As with any other PowerShell cmdlet, you can display the syntax for any of these cmdlets by using PowerShell’s Get-Help cmdlet. We have to type Get-Help, followed by the cmdlet’s name that we need help with.

For example, if we wanted to see the syntax for the New-StoredCredential cmdlet, we would type:

Get-Help New-StoredCredential
Get-Help NewStoredCredential
Get-Help NewStoredCredential

Add new credentials to the Credential Manager

Step 1 is to add a new credential to the Credential Manager.
This can be done using the GUI, but in this example I will add new vCenter Server credentials using CLI with the New-StoredCredential command.

New-StoredCredential -Target "vCenter-Server" -Persist "LocalMachine" -Credentials $(Get-Credential)

Fill in your username & password, choose OK and head back to the Windows Credential Manager.
The result will look like the example below.

New-StoredCredential command
New-StoredCredential command

Refresh your Windows Credential Manager and you will see the

Windows 11 Credential Manager
The new vCenter Server credentials have been added to the Credential Manager

Use the credentials in our script

Head back to the PowerShell window and run the following commands:

$VCSA = 'vcsa01.vmroe.local'
$Credential = Get-StoredCredential -Target 'vCenter-Server'
Connect-VIServer $VCSA -Credential $Credential

The result will look like the following figure

Connect-VIServer $VCSA -Credential $Credential
Connect-VIServer $VCSA -Credential $Credential

Remove the credentials from the Windows Credential Manager

If you don’t need the credentials anymore, you can easily remove the credentials from the Windows Credential Manager by running to following command:

$Credential = 'vCenter-Server'
Remove-StoredCredential -Target $Credential

Happy coding!

External resources

VMware Developer page for Connect-VIServer

Microsoft Support page for Credential Manager

Other articles on vBlog related to automation

Loading

Share on Social Media
twitter facebook linkedin reddit emailwhatsapptelegram

Leave a Reply Cancel reply

Your email address will not be published. Required fields are marked *

Recent articles

  • vCloud Director API – Couldn’t connect to cloud server with the provided session id May 24, 2023
  • Horizon DaaS – Maximum sessions exceeded May 9, 2023
  • VMware Cloud on AWS with FSx for NetApp ONTAP December 28, 2022
  • Workspace ONE Access – Change certificate December 22, 2022
  • UI themes for VMware Cloud Director 10.4.1 and later December 16, 2022
  • VMware Tanzu Kubernetes Grid December 15, 2022
  • Workspace One Access – Not logged in to server FQDN. Please invoke Save before Sync December 12, 2022
  • NSX Edge configuration has failed. 1G hugepage support required. December 7, 2022
  • Horizon DaaS – Unable to connect to Desktop November 24, 2022
  • How to: Request and Install a Lets Encrypt Wildcard SSL on VMware Cloud Director 10.4 October 17, 2022

Tags

Automation bootstrapping Container Service Extension Credential Manager Desktone.log ESXi EUC EXi GPU Horizon DaaS Instant-Clone Logging NSX nsx-t PowerCLI PowerShell Putty Raspberry PI SSL Tanzu Terraform update vcd-cli vCenter vCloud vCloud Availability vCloud Director VDI vGPU VMware VMworld vSAN vSphere vVols workspace one Zerto

VMware Cloud Provider Blog

  • In the cloud world, one size doesn’t fit all
    by Vijoo Chacko on June 2, 2023 at 7:25 am

    The size make-up of enterprises in an industry can vary from sector to sector. Take for example, the commercial aviation industry. When did you last fly in a commercial plane that was not a Boeing or an Airbus? This is an industry clearly dominated by two major companies. Whereas the automotive industry is an example … Continued The post In the cloud world, one size doesn’t fit all appeared first on VMware Cloud Provider Blog.

  • Reminder: VMware Cloud Director Availability 4.2 and 4.3 End of General Support Approaching
    by Nikolay Patrikov on May 23, 2023 at 3:17 pm

    Keeping VMware Cloud Director Availability always up-to-date guarantees having all the latest and greatest features available for you and your tenants. But one more reason to consider it now is VMware Cloud Director Availability 4.2.x and 4.3.x will reach End of General Support (EOGS) on June 10, 2023, and will no longer be available for download from the VMware download pages. To ensure you … Continued The post Reminder: VMware Cloud Director Availability 4.2 and 4.3 End of General Support Approaching appeared first on VMware Cloud Provider Blog.

  • VMware Aria Rebranding on VMware Cloud Partner Navigator
    by Sulakshna Shrivastava on May 23, 2023 at 2:06 am

    We recently announced the renaming of the products within our Cloud Management family. These Aria rebranding updates have been implemented on the VMware Cloud Partner Navigator portal The post <strong>VMware Aria Rebranding on VMware Cloud Partner Navigator</strong> appeared first on VMware Cloud Provider Blog.

  • Upgrade vSphere now: vSphere 6.5 and 6.7 end of technical guidance is coming this November
    by Christopher Wong on May 20, 2023 at 3:00 pm

    With the general availability of VMware vSphere 8 Update 1, we would like to remind our Cloud Services Provider partner community that the end of general support for vSphere 6.5 and vSphere 6.7 was October 15, 2022. These versions are now under technical guidance until November 15, 2023. During the technical guidance phase, VMware does … Continued The post Upgrade vSphere now: vSphere 6.5 and 6.7 end of technical guidance is coming this November appeared first on VMware Cloud Provider Blog.

  • VMware NSX Migration for VMware Cloud Director 1.4.2 is now GA
    by Jaikishan Tayal on May 9, 2023 at 2:05 pm

    We’re thrilled to announce the release of the VMware NSX Migration tool for VMware Cloud Director 1.4.2! What is this Tool? If you are unaware of the VMware NSX Migration for VMware Cloud Director Tool, it can help you migrate your environment from NSX for vSphere to NSX T Data Center if you are currently … Continued The post VMware NSX Migration for VMware Cloud Director 1.4.2 is now GA appeared first on VMware Cloud Provider Blog.

©2023 vBlog.nl | Design: Newspaperly WordPress Theme